reStructuredText_NPP icon indicating copy to clipboard operation
reStructuredText_NPP copied to clipboard

Provides syntax higlighting for reStructuredText for Notepad++ through a user defined language file.

================================================================================= reStructuredText_NPP_ - reStructuredText basic syntax highlighting for Notepad++

:Author: Steen Hulthin Rasmussen [email protected] :Date: |date| :Description: reStructuredText_NPP_ is a User Defined Language for Notepad++_ that provides basic syntax highlighting for reStructuredText_. :License: reStructuredText_NPP_ is licensed under The MIT License (see http://opensource.org/licenses/mit-license.php or the license.txt file)

.. |date| date:: .. _reStructuredText_NPP: https://github.com/steenhulthin/reStructuredText_NPP .. _Notepad++: http://www.notepad-plus-plus.org/ .. _reStructuredText: http://en.wikipedia.org/wiki/ReStructuredText

Install

#. Make sure you have Notepad++_ installed with the option to use %APPDATA% (which is the default). #. Download and unzip the zipped reStructuredText.xml from the (new) download site_ (This is the only file you need in order to use reStructuredText_NPP_.) #. Start Notepad++ and open the "Define your language..." (Under the "Language" tab)

.. _download site: https://github.com/steenhulthin/reStructuredText_NPP/releases/download/v1.0.0/reStructuredText.zip .. image:: https://github.com/steenhulthin/reStructuredText_NPP/raw/master/documentation/select_user-defined_dialogue.png

  1. Click "import" and select the unzipped reStructuredText.xml file.

.. image:: https://github.com/steenhulthin/reStructuredText_NPP/raw/master/documentation/import_user_define_language.png

  1. Restart Notepad++_
  2. Open .rst file and you should now have syntax highlighting.

Features

reStructuredText_NPP_ provides basic syntax highlighting. reStructuredText_NPP_ is not a full lexer for reStructuredText and does not highlight all elements of reStructuredText markup specification (correctly).

Highlighted element:

  • tables
  • directives
  • Bullet lists
  • Enumerated Lists
  • Field Lists (works, with exception field with space characters)
  • Line Blocks (Only the | [pipe] characters is highlighted)
  • Transitions
  • Footnotes
  • Citations
  • Hyperlinks (with a few exceptions)
  • Substitution