这个项目还在规划中，欢迎加入共同建设制定规范。
This project is still under planning, and you are welcome to join in the joint construction and formulation of specifications.
这是一个Minecraft模组文档库，每个模组拥有属于自己的一个或多个md文件。以通过合并该仓库内的特定文件，导出整合包所需的指南或手册。 不论是整合包制作者还是玩家，拥有单个文件的指南(入门和进阶)或手册(配置)，比去访问每个mod的WIKI、发布页、视频更高效。 对于模组作者或文档作者，您可以新建一个git仓库存放md文件，然后本仓库会使用submodule挂载您的仓库，这样您可以随时管理自己的md文件。
This is a Minecraft mod document library. Each mod has its own one or more md files. A modpack guide or manual can be exported by merging specific files within this repository. Whether you are a modpack creator or a player, it is more efficient to have a single file guide(getting started and advanced) or manual(configuration) than visiting each mod's wiki, release page, and video. For mod authors or docs authors, you can create a new git repository to store md files, and then this repository will use submodule to mount your repository, so that you can manage your own md files at any time.
如果是github渲染这个README.md文件，你只能看见一个超链接"filename"。
如果是docsify渲染该文件，你可以看到被嵌入的docsify_include.md。
If github renders this README.md file, you can only see a hyperlink "filename".
If docsify renders the file, you can see the embedded docsify_include.md.
docsify-demo -> https://0x915.github.io/mcdocs/#/
[作者] 作者名称
[模组] 模组名称
[链接] https://ThisURL
[依赖] 模组名1 简介 https://AURL
[依赖] 模组名2 简介 https://AURL
...
[可选] 模组名A 简介 https://AURL
[可选] 模组名B 简介 https://BURL
...
[冲突] 模组名C 原因 https://CURL
[冲突] 模组名D 原因 https://DURL
...
正文
...
[Author] Author name
[Mod] module name
[Url] https://ThisURL
[Required] ModName1 note https://AURL
[Required] ModName2 note https://AURL
...
[Optional] ModNameA note https://AURL
[Optional] ModNameB note https://BURL
...
[Incompatible] ModNameC why https://CURL
[Incompatible] ModNameD why https://DURL
...
Text content
...
计划使用markdown预编译器做到"在md文件内导入md文件"，生成单文件后转换为pdf或html。
It is planned to use the markdown precompiler to "import the md file within the md file", generate a single file and convert it to pdf or html.
期待更好的想法 / Looking forward to better ideas.