Skip to main content

A django app that parse markdown to html

Project description

This django app provides some features for handling markdown in yout django based website:

  • template_tags for parsing Markdown code to html and cleaning it
  • A form field for editing markdown code and preview the html output

Installation

Dependencies

This app use misaka, a binding for hoedown that use CFFI. You may need to install some package in order to build cffi

On fedora (adapt for your on system or the version of python you xant to use)

dnf install libffi-devel python3-devel
# on fedora, you may need to install this
dnf install redhat-rpm-config

The actual installation

Just install it with pip

pip install django-ml_markdown

Usage

settings.py

Add the path to the configuration class in INSTALLED_APPS

INSTALLED_APP.append(
    'ml_markdown.apps.MlMarkdownConfig'
)

you can also inherit this class for custom settings. See the documentation for details.

Use in templates

You can use one of this filters in your templates:

  • to_html: parse markdown code to html without cleaning it.
  • clean: clean html code with the white list provides as arguments or in the class used for configuration
  • to_cleaned_html: shortcut for| to_html | clean

Some over filter can be found in the documentation.

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_ml_markdown-0.1.0-py3.5.egg (11.1 kB) Copy SHA256 hash SHA256 Egg 3.5 Feb 19, 2017
django_ml_markdown-0.1.0-py3-none-any.whl (7.5 kB) Copy SHA256 hash SHA256 Wheel py3 Feb 19, 2017
django-ml_markdown-0.1.0.tar.gz (4.6 kB) Copy SHA256 hash SHA256 Source None Feb 19, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page