django-jinja-markdown 1.2

Django-Jinja (Jinja2) extension and filter for parsing markdown text markup.

Django-Jinja (Jinja2) extension and filter to parse markdown text in templates.

Requirements

• Django

• Django-Jinja

• Python-Markdown

Installation

Install django-jinja-markdown:

pip install django-jinja-markdown

Add django_jinja_markdown to INSTALLED_APPS.

To be able to use the {% markdown %} tag you should add the Jinja extension to your django_jinja TEMPLATES extensions list:

TEMPLATES = [
    {
        'BACKEND': 'django_jinja.backend.Jinja2',
        'OPTIONS': {
            'extensions': [
                'django_jinja_markdown.extensions.MarkdownExtension',
            ],
        }
    },
]

Basic Use

Examples of using filter in template:

{{ content|markdown }}
{{ markdown('this is **bold**') }}

Or with additional settings:

{{ content|markdown(extensions=['nl2br',]) }}
{{ markdown(content, extensions=['nl2br',]) }}

Example of using extension:

{% markdown %}
Text which will get converted with Markdown.
{% endmarkdown %}

License

This software is licensed under The MIT License (MIT). For more information, read the file LICENSE.

History

Forked in 2016 from the jingo-markdown project. Please see CHANGELOG for more history.

Releasing

1. Update the version number in pyproject.toml.

2. Add an entry to the CHANGELOG file.

3. Tag the commit with the version number: e.g. 1.21.

4. Push the commit and tag to the GitHub repo.

5. Create a new GitHub release, selecting the tag you just pushed to specify the commit. Hit Publish.

6. GitHub will build and release the package to PyPI. Monitor the progress via the Actions tab.