mkdocs-monorepo-plugin:✚在单个Mkdocs中构建多个文档文件夹。 专为大型代码库而设计

时间:2024-02-25 18:14:10
【文件属性】:

文件名称:mkdocs-monorepo-plugin:✚在单个Mkdocs中构建多个文档文件夹。 专为大型代码库而设计

文件大小:96KB

文件格式:ZIP

更新时间:2024-02-25 18:14:10

plugin documentation mkdocs monorepos monoliths

后台/ mkdocs-monorepo-plugin 注意:此插件处于测试版。 虽然预计不会在功能上发生重大变化,但它可能尚未与其他Mkdocs配置完全兼容,因此可能会与某些高级配置一起破坏。 解决这些问题并消除所有错误后,我们将其移至稳定版本。 plugin此插件使您可以在单个Mkdocs中构建多套文档。 它旨在解决Spotify最大和最关键的业务关键代码库(通常是整体或monorepos)中的编写文档。 :pencil: | :snake: | ✚| :closed_book: 产品特点 支持Mkdocs中的多个docs/文件夹。 在大型代码库中只有一个docs/文件夹很难维护。 谁拥有哪个文档? 它与什么代码关联? 使文档


【文件预览】:
mkdocs-monorepo-plugin-master
----.github()
--------CODEOWNERS(301B)
--------workflows()
----mkdocs_monorepo_plugin()
--------merger.py(3KB)
--------parser.py(7KB)
--------__init__.py(0B)
--------plugin.py(3KB)
----requirements.txt(133B)
----mkdocs.yml(1KB)
----LICENSE(11KB)
----__tests__()
--------integration()
--------setup-bats.sh(123B)
--------setup-pip.sh(80B)
--------test-local.sh(1KB)
--------test-ci.sh(743B)
----setup.py(1KB)
----README.md(6KB)
----sample-docs()
--------v2()
--------mkdocs.yml(194B)
--------v1()
--------docs()
----docs()
--------limitations.md(378B)
--------index.md(6KB)
--------CONTRIBUTING.md(8KB)
--------assets()
--------philosophy.md(913B)
--------CODE-OF-CONDUCT.md(3KB)
--------CHANGELOG.md(920B)
----.gitignore(1KB)

网友评论