You are here

README.txt in Markdown 6

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

Provides Markdown filter integration for Drupal 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".

This module is a continuation of the Markdown with Smartypants module (at
http://drupal.org/project/marksmarty), and only includes Markdown support
to simplify configuration. It is now suggested that you use Tipogrify module
(see http://drupal.org/project/typogrify) if you are interested in Smartypants
support.

Note that if you use the GeSHI filter for code syntax highlighting, arrange
this filter after that one.

For more information on Markdown, read:

 - http://daringfireball.net/projects/markdown/syntax
 - http://michelf.com/projects/php-markdown/extra/

Quickstart
--------------------------------------------------------------------------------

1. Move the entire "markdown" directory into your Drupal installation's
   sites/all/modules folder (or your site specific directory).

2. Enable the module on Administer >> Site building >> Modules

3. Set up a new input format or add Markdown support to an existing format at
   Administer >> Site configuration >> Input formats

4. For best security, ensure that the HTML filter is after the Markdown filter
   on the "Reorder" page of the input format and that only markup you would
   like to allow in via HTML and/or Markdown is configured to be allowed via the
   HTML filter.

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

File

README.txt
View source
  1. Markdown filter Drupal module
  2. ================================================================================
  3. Provides Markdown filter integration for Drupal input formats. The Markdown
  4. syntax is designed to co-exist with HTML, so you can set up input formats with
  5. both HTML and Markdown support. It is also meant to be as human-readable as
  6. possible when left as "source".
  7. This module is a continuation of the Markdown with Smartypants module (at
  8. http://drupal.org/project/marksmarty), and only includes Markdown support
  9. to simplify configuration. It is now suggested that you use Tipogrify module
  10. (see http://drupal.org/project/typogrify) if you are interested in Smartypants
  11. support.
  12. Note that if you use the GeSHI filter for code syntax highlighting, arrange
  13. this filter after that one.
  14. For more information on Markdown, read:
  15. - http://daringfireball.net/projects/markdown/syntax
  16. - http://michelf.com/projects/php-markdown/extra/
  17. Quickstart
  18. --------------------------------------------------------------------------------
  19. 1. Move the entire "markdown" directory into your Drupal installation's
  20. sites/all/modules folder (or your site specific directory).
  21. 2. Enable the module on Administer >> Site building >> Modules
  22. 3. Set up a new input format or add Markdown support to an existing format at
  23. Administer >> Site configuration >> Input formats
  24. 4. For best security, ensure that the HTML filter is after the Markdown filter
  25. on the "Reorder" page of the input format and that only markup you would
  26. like to allow in via HTML and/or Markdown is configured to be allowed via the
  27. HTML filter.
  28. Credits
  29. --------------------------------------------------------------------------------
  30. Markdown created by John Gruber:
  31. PHP executions by Michel Fortin:
  32. Drupal filter originally by Noah Mittman: