Package: mkdocs-include-markdown-plugin
mkdocs-include-markdown-pluginMkdocs Markdown includer plugin.Read this document in other languages:EspañolFrançaisInstallationpipinstallmkdocs-include-markdown-pluginDocumentationSetupEnable the plugin in yourmkdocs.yml:plugins:-include-markdownConfigurationThe global behaviour of the plugin can be customized in the configuration.Most of the settings will define the default values passed to arguments
of directives and are documented in thereference.plugins:-include-markdown:encoding:asciipreserve_includer_indent:falsededent:falsetrailing_newlines:truecomments:truerewrite_relative_urls:trueheading_offset:0start:<!--start-->end:<!--end-->#opening_tagandclosing_tag: The default opening and closing tags. By default are{%and%}.plugins:-include-markdown:opening_tag:"{!"closing_tag:"!}"#exclude: Define
global exclusion wildcard patterns. Relative paths defined here will be
relative to thedocs/directory.plugins:-include-markdown:exclude:-LICENSE.md-api/**#cache: Define a
expiration time in seconds for cached HTTP requests when including
from URLs.plugins:-include-markdown:cache:600In order to use this feature, the dependencyplatformdirsmust be installed.
You can include it in the installation of the plugin adding thecacheextra:# requirements.txt
mkdocs-include-markdown-plugin[cache]ReferenceThis plugin provides two directives, one to include Markdown files and another
to include files of any type.Paths of included files can be either:URLs to include remote content.Local files:Absolute paths (starting with a path separator).Relative from the file that includes them (starting with./or../).Relative from thedocs/directory.Bash wildcard globsmatching multiple local files.File paths to include and string arguments can be wrapped by double"or
single'quotes, which can be escaped prepending them a\character as\"and\'.The argumentsstartandendmay contain usual (Python-style) escape
sequences like\nto match against newlines.include-markdownIncludes Markdown files content, optionally using two delimiters to filter the
content to include.#start: Delimiter that marks the beginning of the content to include.#end: Delimiter that marks the end of the content to include.#preserve-includer-indent(true): When this option is enabled (default),
every line of the content to include is indented with the same number of
spaces used to indent the includer{% %}template. Possible values aretrueandfalse.#dedent(false): If enabled, the included content will be dedented.#exclude: Specify with a glob which files should be ignored. Only useful
when passing globs to include multiple files.#trailing-newlines(true): When this option is disabled, the trailing newlines
found in the content to include are stripped. Possible values aretrueandfalse.#encoding(utf-8): Specify the encoding of the included file.
If not definedutf-8will be used.#rewrite-relative-urls(true): When this option is enabled (default),
Markdown links and images in the content that are specified by a relative URL
are rewritten to work correctly in their new location. Possible values aretrueandfalse.#comments(true): When this option is enabled (default), the content to
include is wrapped by<!-- BEGIN INCLUDE -->and<!-- END INCLUDE -->comments which help to identify that the content has been included. Possible
values aretrueandfalse.#heading-offset(0): Increases or decreases the Markdown headings depth
by this number. Only supports number sign (#) heading syntax. Accepts
negative values to drop leading#characters.Examples{%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=falsecomments=false%}{%include-markdown"docs/includes/header.md"heading-offset=1%}{%include-markdown"../LICENSE*"start="<!--license \"start\" -->"end='<!--license "end" -->'exclude="../*.rst"%}{%include-markdown"**"exclude="./{index,LICENSE}.md"%}{%include-markdown'/escap\'ed/single-quotes/in/file\'/name.md'%}includeIncludes the content of a file or a group of files.#start: Delimiter that marks the beginning of the content to include.#end: Delimiter that marks the end of the content to include.#preserve-includer-indent(true): When this option is enabled (default),
every line of the content to include is indented with the same number of
spaces used to indent the includer{% %}template. Possible values aretrueandfalse.#dedent(false): If enabled, the included content will be dedented.#exclude: Specify with a glob which files should be ignored. Only useful
when passing globs to include multiple files.#trailing-newlines(true): When this option is disabled, the trailing newlines
found in the content to include are stripped. Possible values aretrueandfalse.#encoding(utf-8): Specify the encoding of the included file.
If not definedutf-8will be used.Examples~~~yaml{%include"../examples/github-minimal.yml"%}~~~{%include"../examples.md"start="~~~yaml"end="~~~\n"%}{%include'**'exclude='./*.md'%}AcknowledgmentJoe Rickerby and contributors forgiving me the permissionsto separate this plugin from the
documentation ofcibuildwheel.