Mkdocs Markdown 包含插件。
项目描述
mkdocs-include-markdown-plugin
Mkdocs Markdown 包含插件。
阅读本文档的其他语言版本：
安装
pip install mkdocs-include-markdown-plugin
文档
设置
在您的mkdocs.yml：
plugins:
- include-markdown
确保
include-markdown在其他可能发生冲突的插件之前定义，例如mkdocs-macros-plugin.
配置
插件的全局行为可以在配置中自定义。
- # opening_tag和
closing_tag：默认的开始和结束标签。默认情况下是
{%和%}。
其余选项将定义传递给指令参数的默认值，并记录在参考资料中。
plugins:
- include-markdown:
opening_tag: "{!"
closing_tag: "!}"
encoding: ascii
preserve_includer_indent: false
dedent: true
trailing_newlines: false
comments: false
参考
这个插件提供了两个指令，一个包含 Markdown 文件，另一个包含任何类型的文件。
包含文件的路径可以是绝对路径，也可以是相对于包含它们的文件的路径。该参数也接受 glob，在这种情况下，可以使用该exclude参数忽略某些路径。
包含和字符串参数的文件路径可以用双引号"或单'引号括起来，可以在它们前面加上一个\字符作为
\"和进行转义\'。
参数start和end可能包含通常的（Python 风格）转义序列，例如\n匹配换行符。
include-markdown
包含 Markdown 文件内容，可选择使用两个分隔符来过滤要包含的内容。
- # start：标记要包含的内容开始的分隔符。
- # end：标记要包含的内容结束的分隔符。
- #
preserve-includer-indent ( true )：启用此选项时（默认），要包含的每一行内容的缩进数量与用于缩进包含器
{% %}模板的空格数相同。可能的值为true和false。 - # dedent ( false )：如果启用，包含的内容将被删除。
- # exclude：使用全局指定应忽略哪些文件。仅在传递 glob 以包含多个文件时有用。
- #
trailing-newlines ( true ): 当这个选项被禁用时，在要包含的内容中找到的尾随换行符被删除。可能的值为
true和false。 - #
encoding ( utf-8 )：指定包含文件的编码。如果未定义
utf-8将被使用。 - #
rewrite-relative-urls ( true )：启用此选项时（默认），由相对 URL 指定的内容中的 Markdown 链接和图像将被重写以在其新位置正常工作。可能的值为
true和false。 - #
comments ( true )：启用此选项时（默认），要包含的内容被包裹起来，
<!-- BEGIN INCLUDE -->并且<!-- END INCLUDE -->注释有助于识别内容已被包含。可能的值为true和false。 - #
heading-offset (0): 按此数字增加或减少 Markdown 标题深度。仅支持数字符号 (
#) 标题语法。接受负值以删除前导#字符。
例子
{%
include-markdown "../README.md"
start="<!--intro-start-->"
end="<!--intro-end-->"
%}
{%
include-markdown 'docs/includes/header.md'
start='<!--\n\ttable-start\n-->'
end='<!--\n\ttable-end\n-->'
rewrite-relative-urls=false
comments=false
%}
{%
include-markdown "docs/includes/header.md"
heading-offset=1
%}
{%
include-markdown "../LICENSE*"
start="<!--license \"start\" -->"
end='<!--license "end" -->'
exclude="../LICENSE*.rst"
%}
{% include-markdown '/escap\'ed/single-quotes/in/file\'/name.md' %}
include
包括一个文件或一组文件的内容。
- # start：标记要包含的内容开始的分隔符。
- # end：标记要包含的内容结束的分隔符。
- #
preserve-includer-indent ( true )：启用此选项时（默认），要包含的每一行内容的缩进数量与用于缩进包含器
{% %}模板的空格数相同。可能的值为true和false。 - # dedent ( false )：如果启用，包含的内容将被删除。
- # exclude：使用全局指定应忽略哪些文件。仅在传递 glob 以包含多个文件时有用。
- #
trailing-newlines ( true ): 当这个选项被禁用时，在要包含的内容中找到的尾随换行符被删除。可能的值为
true和false。 - #
encoding ( utf-8 )：指定包含文件的编码。如果未定义
utf-8将被使用。
例子
~~~yaml
{% include "../examples/github-minimal.yml" %}
~~~
{%
include "../examples.md"
start="~~~yaml"
end="~~~\n"
%}
{%
include '../LICENSE*'
exclude='../LICENSE*.rst'
%}
致谢
- Joe Rickerby 和贡献者 授予我将这个插件与cibuildwheel的文档分开的权限。
