# Docutils Link List

Author:

  Lea Wiemann, the Docutils team

Contact:
  docutils-develop@lists.sourceforge.net
Revision:
  10148
Date:
  $Date: 2025-05-27 08:17:22 +0200 (Di, 27. Mai 2025) $ [1]
Copyright:
  This document has been placed in the public domain.

Abstract

Links that users of Docutils and reStructuredText may find useful.

[1]

The most current version of this link list can always be found at https://docutils.sourceforge.io/docs/user/links.html. If you find outdated or broken links or want to suggest additions, please let us know and we'll update the list here.

## Extensions

Drop-in components and front-end tools for Docutils that extend the reStructuredText syntax or feature set.

### Import

#### Markdown

- myst-docutils --- the MyST Markdown parser for single page builds.

- pycmark --- small, customizable drop-in parser for CommonMark Markdown.

### Export

#### PDF

- RinohType --- pure Python PDF writer

- rst2pdf (reportlab) --- PDF writer based on ReportLab.

#### Others

- DocBook Writer (only Python 2)

- pickle writer --- "pickle" the document tree to a binary string.

- rst2confluence converts reStructuredText to Confluence CMS markup.

- rst2epub2 (only Python 2)

There are more extensions in the Docutils Sandbox.

## Tools

- a Makefile for driving Docutils,

- rstcheck checks syntax of reStructuredText and code blocks nested within it.

- restview --- live preview for reStructuredText documents,

### Editors

Editors and IDEs with reStructuredText support.

- Eclipse IDE with ReST Editor plug-in.

- Emacs extensible text editor with rst mode.

- Geany lightweight IDE.

- gedit with the gedit-reST-plugin.

- JED programmers editor with rst mode.

- Leo PIM, IDE and outliner (see creating documents from outlines).

- Notepad++ with reStructuredText_NPP (basic syntax highlighting).

- ReSTedit --- Docutils GUI for Mac OS X.

- ReText --- editor for markup languages with live preview.

- RSTPad --- reStructuredText editor with live preview.

- Vim with

  - rest.vim reStructuredText syntax mode,

  - VST (Vim reStructuredText) plugin,

  - VOoM two-pane text outliner, or

  - Riv: Notes and wiki in rST.

- Visual Studio Code with vscode-restructuredtext Language Support extension.

## Related Applications

Applications using Docutils/reStructuredText and helper applications.

### Converters

Alternative implementations to convert between reStructuredText and other formats.

- Pandoc --- universal document converter written in Haskell. Can read/write reStructuredText, DocBook, EPUB, HTML, LaTeX, docx, Markdown, ODT, and more.

- Laika --- Site and E-book Generator and Customizable Text Markup Transformer for sbt, Scala and Scala.js.

- Nim --- system programming language. Supports Nim-flavoured reStructuredText with the rst, rstast, and rstgen modules. The Nim compiler provides the nim rst2html and nim rst2latex sub-commands.

- RST --- PHP library to parse reStructuredText documents.

- Text-Restructured --- a set of Perl modules to parse reStructuredText documents and output them in various formats.

- xml2rst --- an XSLT stylesheet that converts Docutils XML back to reStructuredText.

### Website Generators

- Sphinx Documentation Generator.

- ipsumgenera --- static blog generator written in Nim.

- Nikola --- static site generator.

- Pelican --- another static site generator.

- rest2web --- simple tool for creating web sites with reStructuredText.

- Yozuch --- reStructuredText based static blog generator written in Python.

### Wikis

- MoinMoin includes a ReStructuredText parser.

- Trac supports reStructuredText as alternative wiki markup.

### Development

- Sphinx extends the ReStructuredText syntax to better support the documentation of Software projects.

  Sphinx Extensions allow automatic testing of code snippets, inclusion of docstrings from Python modules (API docs), and more.

- Trac, a wiki and issue tracking system, supports reStructuredText as alternative wiki markup. This includes support for TracLinks via a :trac: role.

- PyLit provides a bidirectional text ↔ code converter for Literate Programming with reStructuredText.

### CMS Systems

- Plone supports reStructuredText content.

- Zope (Zope 4 dropped the ReST shim).

### Presentations

There is native support for slide shows with S5.

- InkSlide quick and easy presentations using Inkscape. InkSlide uses reStructuredText for markup, although it renders only a subset of rST.

- landslide generates HTML5 slideshows from markdown, ReST, or textile.

- marianoguerra/rst2html5 can produce slides using HTML5 + deck.js, impress.js, or reveal.js.

- Pandoc can export to various slide show formats (LaTeX Beamer, PowerPoint, Slidy, S5, ...).

- rst2odp --- rst to LibreOffice impress.

## Help / Q&A

- Stackoverflow tags [restructuredtext] and [docutils].