You are here

Home » API reference » Markdown 8

README.txt in Markdown 8

Same filename and directory in other branches
  1. 5 README.txt
  2. 6 README.txt
  3. 7.2 README.txt
  4. 7 README.txt
Markdown filter Drupal module
=============================

Provides Markdown filter integration for Drupal text 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 can
at the moment use the following:

* PHP Markdown by Michel Fortin <https://michelf.ca/projects/php-markdown/>
* CommonMark <http://commonmark.org>


Installation:
------------

If you are comfortable with composer that is the best way to install both PHP
Markdown and CommonMark. They will then be autoloaded just like other parts of
Drupal 8.

The old way of installation in the libraries directory is only supported for PHP
Markdown. The libraries module is then needed to load the library.

1. Download and install the libraries module https://www.drupal.org/project/libraries.
2. Download the PHP Markdown library from
   https://github.com/michelf/php-markdown/archive/lib.zip, unpack it and place it
   in the "libraries" directory in Drupal root folder, if it doesn't exist you need
   to create it.

Make sure the path becomes "/libraries/php-markdown/Michelf/MarkdownExtra.inc.php".


Markdown editor:
---------------

If you are interested in a Markdown editor please check out
the Markdown editor for BUEditor module.

<http://drupal.org/project/markdowneditor>


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.

Filters that should be run before Markdown filter includes:

* Code Filter
* GeSHI filter for code syntax highlighting

Filters that should be run after Markdown filter includes:

* Typogrify

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 via HTML and/or Markdown is
configured to be allowed.

If you on the other hand want to make sure that all converted Markdown
text is perserved, run it before the Markdown filter. Note that blockquoting
with Markdown doesn't work in this case since "Limit allowed HTML tags" filter
converts the ">" in to "&gt;".


Smartypants support:
-------------------

This module is a continuation of the Markdown with Smartypants module.
It only includes Markdown support and it is now suggested that you use
Typogrify module if you are interested in Smartypants support.

<http://drupal.org/project/typogrify>


Credits:
-------
Markdown created                     by John Gruber: <http://daringfireball.net>
Drupal filter originally             by Noah Mittman: <http://www.teradome.com/>

File

README.txt
View source 
  1. Markdown filter Drupal module

  2. =============================

  3. 

  4. Provides Markdown filter integration for Drupal text formats. The

  5. Markdown syntax is designed to co-exist with HTML, so you can set up

  6. input formats with both HTML and Markdown support. It is also meant to

  7. be as human-readable as possible when left as "source".

  8. 

  9. There are many different Markdown implementation. Markdown filter can

  10. at the moment use the following:

  11. 

  12. * PHP Markdown by Michel Fortin 

  13. * CommonMark 

  14. 

  15. 

  16. Installation:

  17. ------------

  18. 

  19. If you are comfortable with composer that is the best way to install both PHP

  20. Markdown and CommonMark. They will then be autoloaded just like other parts of

  21. Drupal 8.

  22. 

  23. The old way of installation in the libraries directory is only supported for PHP

  24. Markdown. The libraries module is then needed to load the library.

  25. 

  26. 1. Download and install the libraries module https://www.drupal.org/project/libraries.

  27. 2. Download the PHP Markdown library from

  28.    https://github.com/michelf/php-markdown/archive/lib.zip, unpack it and place it

  29.    in the "libraries" directory in Drupal root folder, if it doesn't exist you need

  30.    to create it.

  31. 

  32. Make sure the path becomes "/libraries/php-markdown/Michelf/MarkdownExtra.inc.php".

  33. 

  34. 

  35. Markdown editor:

  36. ---------------

  37. 

  38. If you are interested in a Markdown editor please check out

  39. the Markdown editor for BUEditor module.

  40. 

  41. 

  42. 

  43. 

  44. Important note about running Markdown with other input filters:

  45. --------------------------------------------------------------

  46. 

  47. Markdown may conflict with other input filters, depending on the order

  48. in which filters are configured to apply. If using Markdown produces

  49. unexpected markup when configured with other filters, experimenting with

  50. the order of those filters will likely resolve the issue.

  51. 

  52. Filters that should be run before Markdown filter includes:

  53. 

  54. * Code Filter

  55. * GeSHI filter for code syntax highlighting

  56. 

  57. Filters that should be run after Markdown filter includes:

  58. 

  59. * Typogrify

  60. 

  61. The "Limit allowed HTML tags" filter is a special case:

  62. 

  63. For best security, ensure that it is run after the Markdown filter and

  64. that only markup you would like to allow via HTML and/or Markdown is

  65. configured to be allowed.

  66. 

  67. If you on the other hand want to make sure that all converted Markdown

  68. text is perserved, run it before the Markdown filter. Note that blockquoting

  69. with Markdown doesn't work in this case since "Limit allowed HTML tags" filter

  70. converts the ">" in to ">".

  71. 

  72. 

  73. Smartypants support:

  74. -------------------

  75. 

  76. This module is a continuation of the Markdown with Smartypants module.

  77. It only includes Markdown support and it is now suggested that you use

  78. Typogrify module if you are interested in Smartypants support.

  79. 

  80. 

  81. 

  82. 

  83. Credits:

  84. -------

  85. Markdown created                     by John Gruber: 

  86. Drupal filter originally             by Noah Mittman: