Skip to content

twardoch/mkdocs-markdown-in-template-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mkdocs-markdown-in-template-plugin

MkDocs plugin that allows to use Markdown in your theme’s Jinja2 templates

Installation

python3 -m pip install git+https://github.com/twardoch/mkdocs-markdown-in-template-plugin

Configuration

In mkdocs.yaml (as early as possible in the list of plugins):

plugins:
  - markdown-in-template

Usage

In any HTML template partial, you can now include Markdown enclosed in {% md %} and {% mdend %}:

<article>
{% md %}
# Heading

Regular and **bold** text
{% mdend %}
</article>

Note: The plugin will remove any indentation equal to the indentation of the first line of the Markdown.

About

MkDocs plugin that allows to use Markdown in your theme’s Jinja2 templates

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages