文件名称：mkdocs-simple-plugin:将代码内的文档文件构建到MkDocs中
文件大小：119KB
文件格式：ZIP
更新时间：2024-04-18 07:52:35
Python
mkdocs-simple-plugin | | | | | | 使用此插件，您可以使用从穿插在代码中的markdown构建文档站点。 它是为开发人员通常在其代码中编写文档的方式而设计的-在代码中带有简单的markdown文件和/或markdown注释块。 关于 您可能想知道为什么要为项目生成一个静态站点，而又不进行将所有文档合并到单个docs文件夹中或使用单个README文件的典型“ wiki”事情。 我的存储库对于单个文档源来说太大了。 有时将所有文档合并到较高级别的docs目录中是不可行的。 中型/大型存储库通常是这种情况。 通常，如果您的代码库太大而无法放在单个include目录中，则您的代码库也可能太大而无法将文档放在单个docs目录中。 由于通常在保持文档与代码尽可能接近的位置上使文档保持最新状态比较容易，因此最好为文档创建多个源。 我的存储库对于高级文档来说太简