This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
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.

Release History

Release History

0.1.0

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django_ml_markdown-0.1.0-py3.5.egg (11.1 kB) Copy SHA256 Checksum SHA256 3.5 Egg Feb 19, 2017
django_ml_markdown-0.1.0-py3-none-any.whl (7.5 kB) Copy SHA256 Checksum SHA256 py3 Wheel Feb 19, 2017
django-ml_markdown-0.1.0.tar.gz (4.6 kB) Copy SHA256 Checksum SHA256 Source Feb 19, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting