Skip to content

Adds a markdown template filter to the jinja templating environment in mkdocs.

License

Notifications You must be signed in to change notification settings

byrnereese/mkdocs-markdown-filter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mkdocs-bootstrap-tables-plugin

This plugin adds a "markdown" template filter to mkdocs.

Setup

Install the plugin using pip:

pip install mkdocs-markdown-filter

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - markdown-filter

Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set, but now you have to enable it 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.

About

Adds a markdown template filter to the jinja templating environment in mkdocs.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published