Mkdocs plugin that allow to inject external markdown or markdown section from given url
Project description
MkDocs Embed External Markdown Plugin
About
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.
Installation
Install the package with pip:
pip install mkdocs-embed-external-markdown
Configuration
Enable the plugin in your mkdocs.yml
file:
plugins:
- external-markdown
Usage
- Section defined by "##" header (h2)
- "#" header (h1) will be removed from sorce content so you can use use your own header
- "##" header (h2) will be removed from sorce 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') }}
MkDocs Example
The following example shows how to use the plugin in mkdocs project:
# Example Page
This is an example page.
## Embedding multiple markdown sections from different urls
### First Embedded Section
{{ external_markdown('https://raw.githubusercontent.com/mkdocs/mkdocs/master/README.md', 'Features') }}
### Second Embedded Section
{{ external_markdown('https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/README.md', 'Quick start') }}
Will produce the following page:
How To Prevent Accidental Interpretation Of "Jinja-like" Statements
The most frequent issue when adding the MkDocs Embed External Markdown Plugin
to 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 the MkDocs Embed External Markdown Plugin meets 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) | Description |
---|---|
Code | Documented Jinja2 statements (or similar syntax), LaTeX |
Maths | LaTeX statements |
Elsewhere | Some pre-existing templating or macro language, typically with some constructs starting with {# or {{ . |
Code Blocks Containing Similar Languages
With MkDocs, this situation typically occurs when the website is documenting an application that relies on a "djangolike/jinjalike language" like:
- Django Template Language
- Jinja2 (Python)
- Nunjucks (Javascript)
- Twig (PHP)
- ...
This may also happen for pages that documents Ansible directives, which often contain variables expressed in a Jinja2 syntax.
Solutions - Explicitly marking the snippets as 'raw'
{% raw %}
```bash
docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' container_name_or_id
```
{% endraw %}
Known Issues
- Embedding links without
.md
extension not working properly
License
MIT License
Copyright© 3os.org @ 2022
Permission 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs-embed-external-markdown-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 91d2c7505bac2ed66ffdc2b398baea3c8bf599a98862e096e83b1bad1c89d1b2 |
|
MD5 | 015e391105aacd844c2c65c140e305ba |
|
BLAKE2b-256 | ea07ad763b6c3d0176fd1fd6cb9659a9dbb006b38d0827f3c60b402c09c69e8d |
Hashes for mkdocs_embed_external_markdown-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e2cec9f971a19ff5f14a6ee2e9f0453bc849886aa3e02e5eb93582243af7698c |
|
MD5 | 2f43a2698639cb293e2d74706c37a256 |
|
BLAKE2b-256 | e3e09068766b1a7a04dc9b39a7ac08448f2ba55d4b0b5e78a5e4aa0edd25344c |