Tools & Setup for Editing reST¶
When editing reST files locally, you should use an editor or IDE with good support for syntax highlighting and marking errors in reST.
PhpStorm is commonly used by developers in the TYPO3 community. It does however cost money.
Good alternatives can be found in the "Free Editors" section of StackOverflow: reStructuredText tool support.
You should activate some plugins that will assist you when editing reST
files. In order to activate a plugin, press
ctrl + alt + s, then
select Plugins, search for the plugin and enable it (mark
If the Plugin is not installed yet, you may have to Browse repositories, select the plugin and click the green Install button.
Enable the reStructuredText plugin to get correct syntax highlighting. The plugin will also point out errors, for example wrong title underline length.
Additionally, (download) and enable the EditorConfig plugin in order to get correct Coding Guideline settings like indent width already defined in .editorconfig file of documentation project.