Package: mkdocs-embed-external-markdown-sd0408
MkDocs Embed External Markdown PluginAboutMkDocs Embed External Markdown plugin that allows to injectsectionorfull markdowncontent from a given url.
The goal is to embed different markdown from different sources inside your MkDocs project.Version 2.xxBraking change: Section name must include Markdown Section header like:## Section nameChangelog:Added support for multi level sections such as### Section nameand#### Section nameBetter Handling of parsing makrdowns wich contains#in the contentFailing Mkdocs Build when Markdown content cannot be fetchedInstallationInstall the package with pip:pipinstallmkdocs-embed-external-markdownConfigurationEnable the plugin in yourmkdocs.ymlfile:plugins:-external-markdownUsageSection defined by"##/###/####..."header (h2/h3/h4...)"#"header (h1) will beremovedfrom source content so you can use use your own header"##/###/####..."header (h2/h3/h4...) will beremovedfrom sourcesectioncontent so you can use use your own headerSupports multiplesectionsfrom any sourceexternal_markdownrequires 2 parameters:urlandsection name.{{ external_markdown('url', '## section name') }}Full Markdown ContentEmbed full markdown content from a given url, you can use the following example:{{ external_markdown('https://raw.githubusercontent.com/fire1ce/DDNS-Cloudflare-Bash/main/README.md', '') }}Specific SectionEmbed markdown section from a given url, you can use the following example:{{ external_markdown('https://raw.githubusercontent.com/fire1ce/DDNS-Cloudflare-Bash/main/README.md', '## Installation') }}MkDocs ExampleThe following example shows how to use the plugin in mkdocs project:# Example PageThis is an example page.## Embedding Multiple Markdown Sections From Different URLs### First Embedded Section```markdown{{ external_markdown('https://raw.githubusercontent.com/mkdocs/mkdocs/master/README.md', '## Features') }}```### Second Embedded Section```markdown{{ external_markdown('https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/README.md', '## Quick start') }}```Will produce the following page:How To Prevent Accidental Interpretation OfJinja-likeStatementsThe most frequent issue when adding theMkDocs Embed External Markdown Pluginto an existing mkdocs project, is that some markdown pages may not be rendered correctly, or cause a syntax error, or some other error.The reason is that if Jinja2 template engine in theMkDocs Embed External Markdown Pluginmeets any text that has the standard markers (typically starting with{%} or{{) this will cause a conflict: it will try to interpret that text as a macro and fail to behave properly.The most likely places where this can occur are the following:Location in Markdown file (Block or Inline)DescriptionCodeDocumented Jinja2 statements (or similar syntax), LaTeXMathsLaTeX statementsElsewhereSome pre-existing templating or macro language, typically with some constructs starting with{#or{{.Code Blocks Containing Similar LanguagesWith MkDocs, this situation typically occurs when the website
is documenting an application that relies on adjangolike/jinjalike languagelike:Django Template LanguageJinja2 (Python)Nunjucks (Javascript)Twig (PHP)...This may also happen for pages that documentsAnsibledirectives, which often containvariables expressed in a Jinja2 syntax.Solutions - Explicitly Marking The Snippets asraw{% raw %}```bashdockerinspect-f'{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}'container_name_or_id```{% endraw %}Known IssuesEmbedding links without.mdextension not working properlyLicenseMIT LicenseCopyright© 3os.org @ 2022Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.