Practical Guide: Using Markdown for RPG Maker Project Documentation

じ☆ve冰风

Practical Guide: Using Markdown for RPG Maker Project Documentation
by MiguelRPG​

In this topic, I'll discuss how to use an MD (Markdown) file to create a help file for your RPG Maker project.

As the number of plugins grows and the complexity of your project increases, many configurations require a significant amount of memory from the developer. To help with remembering these configuration details and allow you to focus on other aspects, I recommend keeping a personal help file with instructions for plugins, tileset configurations, and regions.

I'll explain how I've been doing this, and I hope it will be useful for those dealing with many plugins.

Tips for Working:​

• Only note what you use and in your own words. This isn't the plugin's help file, it's what you always need to configure events, scenes, maps, tilesets, etc.
  
• Keep it simple. It's meant to help, not hinder.
  
• Don't do it all at once. Gradually build this file.
  
• Keep it updated. If an instruction or configuration changes, update it here. Don't leave it outdated, or it will lose its usefulness.
  

Creating the MD File​

Attached is an example, and below I'll explain how to view the file in your workspace.

• Titles are defined with # and are hierarchized by the number of #, for example: # Title ## Subtitle
  
• Tables are defined like this:
                  Markdown (GitHub flavored):        
  1. | Header 1   | Header 2   |
  2. |------------|------------|
  3. | Item 1     | Item 2     |

  复制代码
  
  
  
  
• By creating multiple tables, you can define specific scopes.
  
  

Preview​

I am using the VS Code extension: Markdown Preview Enhanced

Spoiler: Using Markdown Preview Enhanced

1. install the extension in VS Code
2. open the file in VS Code
3. right click on open text


4. In the menu that opens, click on the "Markdown Preview Enhanced: Open Preview to the Side" option

There are more tags you can use. See here: Markdown Guide

---

Note: This translation was done automatically. I am open to suggestions for improvement.

---

With these guidelines, you can create an efficient help file for your RPG Maker project.


本贴来自国际rpgmaker官方论坛作者:MiguelRPG处,因国际论坛即将永久关站,为了存档多年珍贵资料,署名转载到本论坛存档,由于官方帖子为英文原帖，需要中文翻译请点击论坛顶部切换语言为中文就可以将帖子翻译成中文浏览,方便大家随时查看,原文地址：https://forums.rpgmakerweb.com/threads/practical-guide-using-markdown-for-rpg-maker-project-documentation.168995/