reStructuredText
reStructuredText (short ReST , reST or RST ) is a simplified markup language with the aim of being particularly readable in the pure text form. Furthermore, reStructuredText should be easily convertible into other formats.
background
The reStructuredText parser is a component of Docutils, a word processing library developed in the Python programming language . Version 0.6 supports conversion to ODT , manpage , S5 , XHTML , XML and LaTeX . The latter enables professional typesetting with export options to PostScript and PDF . The current version of Docutils is 0.16 (as of January 12, 2020).
reStructuredText is widely used in the formatting of docstrings, the Python-typical comments on program documentation. The Sphinx software documentation tool uses reStructuredText. In addition, some wiki systems offer reStructuredText as an alternative to their own wiki syntax .
GitHub , Bitbucket and GitLab support reST.
Comparable easy markup languages are e.g. B. Markdown , Textile and AsciiDoc .
Syntax examples
Headlines:
Abschnitt =========
Unterabschnitt --------------
Bulleted lists:
- Erster Punkt
- Zweiter Punkt
- Ein Unterpunkt
- Dritter Punkt
1) Ein Punkt einer nummerierten Liste
2) Zweites...
a) Unterpunkt einer nummerierten Liste
i) Noch eine Ebene tiefer...
3) Dritter Punkt der nummerierten Liste
Named hyperlinks :
Dieser Satz dient zur Demonstration_ von `Hyperlinks in reST`_.
.. _Demonstration: http://de.wikipedia.org/wiki/Demonstration .. _Hyperlinks in reST: http://docutils.sourceforge.net/docs/user/rst/quickref.html#hyperlink-targets
Anonymous hyperlinks:
Ein Satz mit einem `anonymen Link auf die Python-Website`__.
__ http://www.python.org/
Footnotes:
Hier steht nicht viel [#]_. Schauen sie einfach mal ans Ende der Seite.
.. [#] Fußnoten können automatisch durchnummeriert werden. Mehr dazu in der reST-Kurzreferenz
Web links
- Docutils
- reStructuredText
- ReST quick reference
- NoTex - A browser-based reStructuredText editor
- Online reStructuredText editor