README.md
20 lines
| 1 | # Markdown parsing library |
| 2 | |
| 3 | Contains two libraries: |
| 4 | |
| 5 | * `/extra` |
| 6 | - Gives you `MardownExtra_Parser` and `Markdown_Parser` |
| 7 | - Docs at http://michelf.ca/projects/php-markdown/extra/ |
| 8 | |
| 9 | * `/gfm` -- Github Flavored Markdown |
| 10 | - Gives you `WPCom_GHF_Markdown_Parser` |
| 11 | - It has the same interface as `MarkdownExtra_Parser` |
| 12 | - Adds support for fenced code blocks: https://help.github.com/articles/creating-and-highlighting-code-blocks/#fenced-code-blocks |
| 13 | - By default it replaces them with a code shortcode |
| 14 | - You can change this using the `$use_code_shortcode` member variable |
| 15 | - You can change the code shortcode wrapping with `$shortcode_start` and `$shortcode_end` member variables |
| 16 | - The `$preserve_shortcodes` member variable will preserve all registered shortcodes untouched. Requires WordPress to be loaded for `get_shortcode_regex()` |
| 17 | - The `$preserve_latex` member variable will preserve oldskool $latex yer-latex$ codes untouched. |
| 18 | - The `$strip_paras` member variable will strip <p> tags because that's what WordPress likes. |
| 19 | - See `WPCom_GHF_Markdown_Parser::__construct()` for how the above member variable defaults are set. |
| 20 |