Metadata-Version: 2.4
Name: mkdocs-markupsafe-markdown-filter
Version: 0.1.1
Summary: A MkDocs plugin to add a markdown filter to jinja templates.
Project-URL: Source, https://github.com/ntno/mkdocs-markupsafe-markdown-filter
Project-URL: Issues, https://github.com/ntno/mkdocs-markupsafe-markdown-filter/issues
Author-email: Byrne Reese <byrne@majordojo.com>, Natan Organick <markupsafe.markdown.filter@gmail.com>
Maintainer: Natan Organick
License-Expression: MIT
License-File: LICENSE
Keywords: jinja,mkdocs
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Python: >=3.8
Requires-Dist: markupsafe
Requires-Dist: mkdocs
Description-Content-Type: text/markdown

# mkdocs-markupsafe-markdown-filter

This plugin adds [pallets' MarkupSafe] template filter to mkdocs.

[pallets' MarkupSafe]: https://github.com/pallets/markupsafe/

## Setup

Install the plugin using pip:

`pip install mkdocs-markupsafe-markdown-filter`

Activate the plugin in `mkdocs.yml`:
```yaml
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][mkdocs-plugins].

## 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][mkdocs-template].

More information about blocks [here][mkdocs-block].

[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
[mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables
[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks
