5 :Author: Lea Wiemann, the Docutils team
6 :Contact: docutils-develop@lists.sourceforge.net
9 :Copyright: This document has been placed in the public domain.
11 .. title:: Docutils Links
15 This document contains links users of Docutils and reStructuredText
16 may find useful. Many of the projects
17 listed here are hosted in the `Docutils Sandbox`_. If you have
18 something to publish, you can get write access, too!
20 The most current version of this link list can always be found at
21 http://docutils.sourceforge.net/docs/user/links.html.
23 .. _Docutils: http://docutils.sourceforge.net/
24 .. _Docutils Sandbox: http://docutils.sf.net/sandbox/README.html
30 Advanced text editors with reStructuredText support, IDEs, and docutils GUIs:
32 * Emacs `rst mode <http://docutils.sf.net/tools/editors/emacs>`__.
34 * `Vim <http://www.vim.org/index.php>`__:
36 - `reStructuredText syntax highlighting mode
37 <http://www.vim.org/scripts/script.php?script_id=973>`__,
39 - `VST <http://www.vim.org/scripts/script.php?script_id=1334>`__ (Vim
40 reStructuredText) plugin for Vim7 with folding.
42 - `VOoM <http://www.vim.org/scripts/script.php?script_id=2657>`__
43 plugin for Vim that emulates two-pane outliner with
44 support for reStructuredText (since version 4.0b2).
46 - `Riv: Take notes in rst <https://github.com/Rykka/riv.vim>`__ Vim
47 plugin to take notes in reStructured text.
49 * `JED <http://www.jedsoft.org/jed/>`__ programmers editor with
50 `rst mode <http://jedmodes.sf.net/mode/rst/>`__
52 * `reStructuredText editor plug-in for Eclipse`__
54 __ http://resteditor.sf.net/
56 * Gnome's gedit offers syntax highlighting and a reST preview pane.
58 Latest version of the plugin is available from `bittner @ github`_
59 (See also: `Gedit third party plugins`__).
61 __ https://wiki.gnome.org/Apps/Gedit/ThirdPartyPlugins-v3.8
63 .. _bittner @ github: https://github.com/bittner/gedit-reST-plugin
65 * A BBEdit_/TextWrangler `language module`__ for editing reST documents.
67 .. _BBEdit: https://en.wikipedia.org/wiki/BBEdit
68 __ http://ericfromcanada.bitbucket.org/
70 * Gunnar Schwant's DocFactory_ is a wxPython GUI application for
73 * ReSTedit_ by Bill Bumgarner is a Docutils GUI for Mac OS X.
75 * Leo_ is an outliner_, written in Python using PyQt. It can be used as IDE
76 for literal programming, as a filing cabinet holding any kind of data and
77 as `document editor`__ with outlines containing reStructuredText markup.
79 .. _outliner: http://en.wikipedia.org/wiki/Outliner
80 __ http://leoeditor.com/tutorial-rst3.html
82 * `NoTex <https://notex.ch>`_ is a browser based reStructuredText editor
83 with syntax highlighting and PDF/HTML export functionality using Sphinx.
85 * `rsted <https://github.com/anru/rsted>`_ is a "simple online editor for
86 reStructuredText on Flask". You can try it on http://rst.ninjs.org/
88 .. _DocFactory: http://docutils.sf.net/sandbox/gschwant/docfactory/doc/
89 .. _ReSTedit: http://www.friday.com/bbum/index.php?s=restedit
90 .. _Leo: http://leoeditor.com/
96 Convert reStructuredText to other formats:
101 * `rst2pdf (reportlab)
102 <http://rst2pdf.googlecode.com>`_ is a tool to go
103 directly from reStructuredText to PDF, via `reportlab
104 <http://www.reportlab.org/rl_toolkit.html>`_. No LaTeX installation is
107 * `rst2pdf (pdflatex)
108 <http://docutils.sourceforge.net/sandbox/blais/rst2pdf/>`_ by Martin Blais
109 is a minimal front end producing LaTeX, compiling the LaTeX file, getting
110 the produced output to the destination location and finally deleting all
111 the messy temporary files that this process generates.
114 <http://docutils.sf.net/sandbox/rst2pdf/README.html>`_ is
115 a front end for the generation of PDF documents from a reStructuredText
116 source via LaTeX in one step cleaning up intermediate files. It uses the
117 `rubber <http://iml.univ-mrs.fr/~beffara/soft/rubber/>`_ Python wrapper
118 for LaTeX and friends.
120 * ``py.rest`` from the Codespeak `py Lib scripts`_ converts
121 reStructuredText files to HTML and PDF (cleaning up the intermediate
122 latex files). Similar to ``buildhtml.py``, it looks recursively for
123 .txt files in the given PATHS.
125 * rlpdf_ is another PDF Writer based on ReportLabs.
127 .. _py Lib scripts: http://codespeak.net/py/dist/bin.html
128 .. _rlpdf: http://docutils.sf.net/sandbox/dreamcatcher/rlpdf/
134 * Since version 0.5, the odtwriter_ by Dave Kuhlman is part of the Docutils_
137 .. _odtwriter: http://docutils.sf.net/docs/user/odt.html
140 website generators and HTML variants
141 ````````````````````````````````````
143 * The Sphinx_ Python Documentation Generator by Georg Brandl was originally
144 created to translate the `Python documentation`_, and is now `used by
145 <http://sphinx.pocoo.org/examples.html>`__ a wide choice of projects.
147 It can generate complete web sites (interlinked and indexed HTML pages)
148 and/or PDF from a set of rst source files.
150 * Nikola_ static site generator, use restructured text by
153 * rst2ht_ by Oliver Rutherfurd, converts reStructuredText to an .ht
154 template, for use with ht2html_.
156 * htmlnav_ by Gunnar Schwant, is an HTML writer which supports navigation
159 * rest2web_, by Michael Foord, is a tool for creating web sites with
162 * rst2chm_ by Oliver Rutherfurd, generates Microsoft HTML Help files from
163 reStructuredText files.
165 * `html4strict <http://docutils.sf.net/sandbox/html4strict/>`__
166 produces XHTML that strictly conforms to the XHTML 1.0 specification.
168 * `html4trans <http://docutils.sf.net/sandbox/html4trans/>`__
169 produces XHTML conforming to the version 1.0 Transitional DTD that
170 contains enough formatting information to be viewed by a lightweight HTML
171 browser without CSS support.
173 * A `simple HTML writer`_ by Bill Bumgarner that doesn't rely on CSS
176 .. _Sphinx: http://sphinx.pocoo.org/
177 .. _nikola: http://getnikola.com/
178 .. _rst2ht: http://www.rutherfurd.net/articles/rst-ht2html.html
179 .. _ht2html: http://ht2html.sourceforge.net/
180 .. _htmlnav: http://docutils.sf.net/sandbox/gschwant/htmlnav/
181 .. _rst2chm: http://www.rutherfurd.net/software/rst2chm/
182 .. _rest2web: http://www.voidspace.org.uk/python/rest2web/
183 .. _simple HTML writer: http://docutils.sf.net/sandbox/bbum/DocArticle/
189 * Pandoc_ is a document converter that can write Markdown, reStructuredText,
190 HTML, LaTeX, RTF, DocBook XML, and S5.
192 * restxsl_ by Michael Alyn Miller, lets you transform reStructuredText
193 documents into XML/XHTML files using XSLT stylesheets.
195 * An `XSLT script`__ by Ladislav Lhotka enables reStructuredText annotations
196 to be included in RELAG NG XML schemas.
198 __ http://www.cesnet.cz/doc/techzpravy/2006/rngrest/
200 * `DocBook Writer`_ by Oliver Rutherfurd.
202 * Nabu_, written by Martin Blais, is a publishing system which
203 extracts information from reStructuredText documents and stores it
204 in a database. Python knowledge is required to write extractor
205 functions (see `Writing an Extractor`_) and to retrieve the data
206 from the database again.
208 * The `pickle writer`_ by Martin Blais pickles the document tree to a binary
209 string. Later unpickling will allow you to publish with other Writers.
211 * The `Texinfo Writer`_, by Jon Waltman converts reStructuredText to
212 Texinfo, the documentation format used by the GNU project and the
213 Emacs text editor. Texinfo can be used to produce multiple output
214 formats, including HTML, PDF, and Info.
216 * For `confluence CMS`_ see https://github.com/netresearch/rst2confluence.
218 * Deploying into wikis might be aided by deploy-rst_.
220 .. _Pandoc: http://sophos.berkeley.edu/macfarlane/pandoc/
221 .. _restxsl: http://www.strangeGizmo.com/products/restxsl/
222 .. _DocBook Writer: http://docutils.sf.net/sandbox/oliverr/docbook/
223 .. _Nabu: http://furius.ca/nabu/
224 .. _Writing an Extractor: http://furius.ca/nabu/doc/nabu-extractor.html
225 .. _pickle writer: http://docutils.sf.net/sandbox/blais/pickle_writer/
226 .. _Texinfo Writer: http://docutils.sf.net/sandbox/texinfo-writer/README.html
227 .. _confluence CMS: http://www.atlassian.com/software/confluence
228 .. _deploy-rst: https://github.com/netresearch/deploy-rst
234 Convert other formats to reStructuredText:
236 * sxw2rest_, by Trent W. Buck, converts StarOffice XML Writer (SXW)
237 files to reStructuredText.
239 * xml2rst_, an XSLT stylesheet written by Stefan Merten, converts XML
240 dumps of the document tree (e.g. created with rst2xml.py) back to
243 * xhtml2rest_, written by Antonios Christofides, is a simple utility
244 to convert XHTML to reStructuredText.
246 * Sphinx_ includes a `LaTeX to Rst converter
247 <http://svn.python.org/projects/doctools/converter/>`__ in its source code
248 (trimmed to importing the old Python docs).
250 * Pandoc_ can read Markdown and (subsets of) HTML, and LaTeX and export to
251 (amongst others) reStructuredText.
253 * PySource_, by Tony Ibbs, is an experimental Python source Reader.
254 There is some related code in David Goodger's sandbox
255 (pysource_reader_) and a `Python Source Reader`_ document.
257 .. _sxw2rest: http://twb.ath.cx/~twb/darcs/sxw2rest/
258 .. _xml2rst: http://www.merten-home.de/FreeSoftware/xml2rst/index.html
259 .. _xhtml2rest: http://docutils.sf.net/sandbox/wiemann/xhtml2rest/
261 .. _PySource: http://docutils.sf.net/sandbox/tibs/pysource/
262 .. _pysource_reader: http://docutils.sf.net/sandbox/davidg/pysource_reader/
263 .. _Python Source Reader: http://docutils.sf.net/docs/dev/pysource.html
269 Extend the reStructuredText syntax or the features of Docutils.
270 More extensions are in the `Docutils Sandbox`_.
272 * Beni Cherniavsky has written a generic `preprocessing module`_ for
273 roles and/or directives and built preprocessors for TeX math for
274 both LaTeX and HTML output on top of it.
276 * Beni Cherniavsky maintains a Makefile_ for driving Docutils, hoping
277 to handle everything one might do with Docutils.
279 * The `ASCII art to SVG converter`_ (aafigure) developed by
280 Chris Liechti can parse ASCII art images, embedded in reST documents and
281 output an image. This would mean that simple illustrations could be
282 embedded as ASCII art in the reST source and still look nice when
283 converted to e.g. HTML
285 * zot4rst_ by Erik Hetzner is an extension that allows users to write reST
286 documents using citations from a Zotero_ library.
288 * Quick and easy publishing reStructuredText source files as blog posts
289 on blogger.com is possible with `rst2blogger`_ .
291 .. _preprocessing module: http://docutils.sf.net/sandbox/cben/rolehack/
292 .. _Makefile: http://docutils.sf.net/sandbox/cben/make/
293 .. _ASCII art to SVG converter:
294 http://docutils.sf.net/sandbox/cliechti/aafigure/
295 .. _zot4rst: http://e6h.org/~egh/hg/zotero-plain
296 .. _Zotero: http://www.zotero.org/
297 .. _rst2blogger: https://github.com/dhellmann/rst2blogger#readme
303 Applications using docutils/reStructuredText and helper applications.
305 * For Wikis, please see the `FAQ entry about Wikis`_.
307 * For Blogs (Weblogs), please see the `FAQ entry about Blogs`_.
309 * `Project Gutenberg`_ uses docutils, but with it's own xetex- and nroff-writer
312 .. _FAQ entry about Wikis: http://docutils.sf.net/FAQ.html#are-there-any-wikis-that-use-restructuredtext-syntax
313 .. _FAQ entry about Blogs: http://docutils.sf.net/FAQ.html#are-there-any-weblog-blog-projects-that-use-restructuredtext-syntax
314 .. _Project Gutenberg: http://www.gutenberg.org
320 * Sphinx_ extends the ReStructuredText syntax to better support the
321 documentation of Software (and other) *projects* (but other documents
322 can be written with it too).
324 Since version 2.6, the `Python documentation`_ is based on
325 reStructuredText and Sphinx.
327 * Trac_, a project management and bug/issue tracking system, supports
328 `using reStructuredText
329 <http://trac.edgewall.org/wiki/WikiRestructuredText>`__ as an
330 alternative to wiki markup.
332 * PyLit_ provides a bidirectional text <--> code converter for *literate
333 programming with reStructuredText*.
335 * If you are developing a Qt app, rst2qhc_ lets you generate the whole help
336 automatically from reStructuredText. That includes keywords, TOC,
337 multiple manuals per project, filters, project file, collection project
340 .. _Python documentation: http://docs.python.org/
341 .. _Trac: http://trac.edgewall.org/
342 .. _PyLit: http://pylit.berlios.de
343 .. _rst2qhc: http://rst2qhc.googlecode.com
349 * Plone_ and Zope_ both support reStructuredText markup.
350 * ZReST_, by Richard Jones, is a "ReStructuredText Document for Zope_"
351 application that is complete and ready to install.
353 .. _Plone: http://plone.org/
354 .. _Zope: http://www.zope.org/
355 .. _ZReST: http://docutils.sf.net/sandbox/richard/ZReST/
361 * rst2html5_ transform restructuredtext documents to html5 + twitter's
362 bootstrap css, deck.js or reveal.js
364 * landslide_ generates HTML5 slideshows from markdown, ReST, or textile.
366 * `native support for S5 <slide-shows.s5.html>`_.
368 * The `PythonPoint interface`_ by Richard Jones produces PDF
369 presentations using ReportLabs' PythonPoint_.
371 * rst2beamer_ generates a LaTeX source that uses the `Beamer` document class.
372 Can be converted to PDF slides with pdfLaTeX/XeLaTeX/LuaLaTeX.
374 * InkSlide_ quick and easy presentations using Inkscape_. InkSlide uses
375 reStructuredText for markup, although it renders only a subset of rst.
377 * rst2outline_ translates a reStructuredText document to a plain text
378 outline. This can then be transformed to PowerPoint.
380 * Pandoc_ can also be used to produce slides, as shown in this
381 `Pandoc Slides Demo`_
383 .. _PythonPoint: http://www.reportlab.org/python_point.html
384 .. _PythonPoint interface: http://docutils.sf.net/sandbox/richard/pythonpoint/
385 .. _rst2beamer: http://docutils.sf.net/sandbox/rst2beamer/
386 .. _Inkscape: http://inkscape.org/
387 .. _InkSlide: http://wiki.inkscape.org/wiki/index.php/InkSlide
388 .. _rst2html5: https://github.com/marianoguerra/rst2html5
389 .. _landslide: https://github.com/adamzap/landslide
390 .. _rst2outline: http://docutils.sf.net/sandbox/rst2outline/
391 .. _Pandoc Slides Demo:
392 http://johnmacfarlane.net/pandoc/demo/example9/producing-slide-shows-with-pandoc