Provides Markdown filter integration for Backdrop input formats. The
Markdown syntax is designed to co-exist with HTML, so you can set up
input formats with both HTML and Markdown support. It is also meant to
be as human-readable as possible when left as "source".
There are many different Markdown implementation. Markdown filter uses
"PHP Markdown extra" that includes many common and useful extensions to
the original Markdown. This includes tables, footnotes and definition
lists.
Read more about Markdown at:
- Original Markdown Syntax by John Gruber
http://daringfireball.net/projects/markdown/syntax - PHP Markdown Extra by Michel Fortin
http://michelf.ca/projects/php-markdown/extra/
Important note about running Markdown with other input filters
Markdown may conflict with other input filters, depending on the order
in which filters are configured to apply. If using Markdown produces
unexpected markup when configured with other filters, experimenting with
the order of those filters will likely resolve the issue.
The "Limit allowed HTML tags" filter is a special case:
For best security, ensure that it is run after the Markdown filter and
that only markup you would like to allow in via HTML and/or Markdown is
configured to be allowed via the it.
If you on the other hand want to make sure that all converted Markdown
text is perserved, run it after the Markdown filter. Note that
blockquoting with Markdown doesn't work when run after "Limit allowed
HTML tags". It converts the ">".
Installation
- Install this module using the official Backdrop CMS instructions at
https://backdropcms.org/guide/modules - Set up a new text format or add Markdown support to a text format at
Administration » Configuration » Content authoring » Text formats
License
This project is GPL v2 software. See the LICENSE.txt file in this directory for
complete text.
Maintainers
Credits
- Markdown created by John Gruber
- PHP executions by Michel Fortin
- Drupal Markdown filter originally by justin2pin
- Ported to Backdrop by Chris Herberte