Authors: 2022-02-26 | Last update: 2022-04-03
| Created: Embed External Markdown¶
MkDocs Embed External Markdown plugin that allows to inject section or full markdown content from a given url. The goal is to embed different markdown from different sources inside your MkDocs project.
For more detailed inforation follow the link: Mkdocs Embed External Markdown Plugin
Usage¶
- Section defined by "##/###/####..." header (h2/h3/h4...)
- "#" header (h1) will be removed from source content so you can use use your own header
- "##/###/####..." header (h2/h3/h4...) will be removed from source section content so you can use use your own header
- Supports multiple sections from any source
external_markdown
requires 2 parameters: url and section name.
{{ external_markdown('url', '## section name') }}
Full Markdown Content¶
Embed 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 Section¶
Embed 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') }}