reStructuredText filter

Categories

Component ID

2558887

Component name

reStructuredText filter

Component type

module

Maintenance status

Development status

Component security advisory coverage

covered

Downloads

968

Component created

Component changed

Component body

Provides reStructuredText filter integration for Drupal input formats. reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system.

Read more about reStructuredText at http://docutils.sourceforge.net/rst.html

RST for Drupal 7

Dependencies

https://www.drupal.org/project/xautoload

Installation

  1. Download and unpack the reStructuredText module directory in your modules folder
    (this will usually be "sites/all/modules/").
  2. Go to "Administer" -> "Modules" and enable the module.
  3. Set up a new text format or add reStructuredText support to an existing text format at
    Administer -> Configuration -> Content Authoring -> Text formats

RST for Drupal 8

The Drupal 8 version follows the recommended composer installation process: You should require it in your project like so:

composer require drupal/rst

This will install the Drupal 8 version of the RST module and require all the needed PHP libraries.

Then similarly to the D7 version:

  1. Go to "Extend" (/admin/modules).
  2. Search for the "ReStructuredText filter (RST)" module and enable it.
  3. Set up a new text format or add reStructuredText support to an existing text format at "Configuration" -> "Text formats and editors" (/admin/config/content/formats).

Global notes

Important note about running reStructuredText with other input filters

reStructuredText may conflict with other input filters, depending on the order
in which filters are configured to apply.

Credits

This module uses an external library for parsing markdown: RST By Grégoire Passault.
Thanks to him :)

Current maintainers

Drupal 7: Qiangjun Ran (jungle) http://ranqiangjun.com
Drupal 8: pacproduct