📁 重复使用内容,摘要和包括
Reusing content, snippets & includes¶
mkdocs-embed-external-markdown¶
Allow to inject section or all full markdown content from a given url. The goal is to show different markdown from different sources inside your MkDocs project.
- author: Stas Yakobov fire1ce
- links: PyPI | Github | Docs
- installation:
pip install mkdocs-embed-external-markdown
codeinclude¶
Allows some advanced 'includes’ functionality to be used for embedded code blocks. This is effectively an extended Markdown format, but is intended to degrade gracefully when rendered with a different renderer.
- author: Richard North rnorth
- links: Github | Docs
- installation:
pip install git+https://github.com/rnorth/mkdocs-codeinclude-plugin
replace¶
The markdown-include
plugin provides a way to “embed” the contents of one file in another markdown file. The replace
plugin allows in reusing the repeating portions of the documentation, instead of rewriting them everywhere.
- author: Sivagiri Visakan SivagiriVisakan
- links: Github | Docs
- installation:
pip install git+https://github.com/SivagiriVisakan/mkdocs-replace-plugin
snippet¶
Injects snippets from a file in a git repository.
- author: Michael Privat mprivat
- links: Pypi | Github | Docs
- installation:
pip install mkdocs-snippet-plugin
git snippet¶
Inject snippet or all markdown content from a given remote git repository
- author: Samuel Comino SamazoOo
- links: Pypi | Github | Docs
- installation:
pip install mkdocs-gitsnippet-plugin
include-markdown¶
Include Markdown content from files
- author: Joe Rickerby joerick
- links: Pypi | Github | Docs
- installation:
pip install mkdocs-include-markdown-plugin
meta-descriptions¶
Generate meta descriptions for your pages using the first paragraph of each page. This is useful if you start each page with a short introduction or summary that can be reused as the meta description.
- author: Paulo Ribeiro
- links: PyPI | GitHub | Docs | Demo
- installation:
pip install mkdocs-meta-descriptions-plugin
mkdocs-version-annotations¶
A few simple macros to make it quicker and easier to add self-consistent annotations to your documentation about differences between project versions.
- author: Glenn Matthews glennmatthews
- links: PyPI | Github | Docs
- installation:
pip install mkdocs-version-annotations