mkdocs-markupsafe-markdown-filter 0.1.0

A MkDocs plugin to add a markdown filter to jinja templates.

mkdocs-markupsafe-markdown-filter

This plugin adds pallets' MarkupSafe template filter to mkdocs.

Setup

Install the plugin using pip:

pip install mkdocs-markupsafe-markdown-filter

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - markupsafe-markdown-filter

Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. This is because MkDocs enables the search plugin by default if there is no plugins entry set. When you add a external plugin like markupsafe-markdown-filter you have to enable the search plugin explicitly.

More information about plugins in the MkDocs documentation.

Usage

Enabling this plugin will filter jinja template code through a markdown filter:

{% set code_content %}
```php linenums="1"
<?php
foo = 1;
bar = 3;
if (foo == bar ) {
  // do something 
}
?>
```
{% endset %}
{{ code_content|markdown }}

See Also

More information about templates here.

More information about blocks here.