迈克：管理MkDocs支持的文档的多个版本

【文件属性】：

文件名称：迈克：管理MkDocs支持的文档的多个版本

文件大小：48KB

文件格式：ZIP

更新时间：2024-02-24 10:15:14

git github-pages documentation-tool mkdocs GitPython

麦克风 mike是一个Python实用程序，可以轻松地将文档的多个版本部署到Git分支，适合通过gh-pages部署到Github。 要查看实际操作的示例，请查看的文档。 为什么要使用迈克？ mike是基于这样的思想：一旦为特定版本生成了文档，就不再需要再次触摸该版本。 这意味着您不必担心会破坏MkDocs中的更改，因为您的旧文档（使用旧版本的MkDocs构建）已经生成并且位于gh-pages分支中。 尽管mike很灵活，但它针对将文档放在.目录中进行了优化，并为特别著名的版本提供了可选的别名（例如latest或dev ）。 这使您可以轻松地永久链接至您要引导人们使用的任何版本的文档。 安装 与大多数Python项目一样，mike使用 ，因此安装可能是您期望的： pip install mike 用法 初始化 首次使用mike之前，您可能需要将mike插件添加到mkdocs.yml文件中。 在使用mike构建文档时，默认情况下会添加此插件，但是通过显式添加它，您可以配置其工作方式。 该插件将版本选择器添加到受支持的主题中，并更新site_url （如

【文件预览】：
mike-master
----setup.py(5KB)
----.gitignore(92B)
----codecov.yml(35B)
----MANIFEST.in(94B)
----LICENSE(1KB)
----setup.cfg(96B)
----mike()
--------versions.py(4KB)
--------templates()
--------__init__.py(0B)
--------app_version.py(23B)
--------server.py(2KB)
--------mkdocs_plugin.py(2KB)
--------mkdocs_utils.py(2KB)
--------git_utils.py(9KB)
--------themes()
--------commands.py(5KB)
--------driver.py(8KB)
----.github()
--------workflows()
----README.md(8KB)
----.coveragerc(227B)
----CHANGES.md(3KB)
----test()
--------data()
--------__init__.py(3KB)
--------integration()
--------unit()
--------scripts()