Metadata-Version: 2.1
Name: django-markdowny
Version: 0.2.0
Summary: A Django template tag to convert Markdown into HTML
Home-page: https://github.com/richardcornish/django-markdowny
Author: Richard Cornish
Author-email: rich@richardcornish.com
License: BSD
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Description-Content-Type: text/x-rst
License-File: LICENSE

Django Markdowny
****************

|PyPI version|_ |Build status|_

.. |PyPI version| image::
   https://badge.fury.io/py/django-markdowny.svg
.. _PyPI version: https://pypi.org/project/django-markdowny/

.. |Build status| image::
   https://api.travis-ci.com/richardcornish/django-markdowny.svg?branch=master
.. _Build status: https://app.travis-ci.com/github/richardcornish/django-markdowny

**Django Markdowny** is a `Django <https://www.djangoproject.com/>`_ `template tag <https://docs.djangoproject.com/en/dev/howto/custom-template-tags/>`_ application to convert `Markdown <https://daringfireball.net/projects/markdown/>`_ into HTML with `Python-Markdown <https://python-markdown.github.io/>`_.

Unlike other Django-Markdown filters, Markdowny supports `all of the options <https://python-markdown.github.io/reference/>`_ in Python-Markdown via `settings <https://django-markdowny.readthedocs.io/en/latest/settings.html>`_.

* `Package <https://pypi.org/project/django-markdowny/>`_
* `Source <https://github.com/richardcornish/django-markdowny>`_
* `Documentation <https://django-markdowny.readthedocs.io/>`_
* `Tests <https://app.travis-ci.com/github/richardcornish/django-markdowny>`_

Install
=======

.. code-block:: bash

   $ pip install django-markdowny

Add to ``settings.py``.

.. code-block:: python

   INSTALLED_APPS = [
       # ...
       'markdowny',
   ]

Usage
=====

Use as a template tag.

.. code-block:: django

   {% load markdowny_tags %}

   {% markdowny %}Hello, world!{% endmarkdowny %}

Or as a template filter.

.. code-block:: django

   {{ post.body|markdowny }}

Result:

.. code-block:: html

   <p>Hello, world!</p>


