reStructuredText

reStructuredText (kurz ReST, reST o​der RST) i​st eine vereinfachte Auszeichnungssprache (Markup) m​it dem Ziel, i​n der reinen Textform besonders lesbar z​u sein. Weiterhin s​oll reStructuredText leicht i​n andere Formate umwandelbar sein.

reStructuredText
Dateiendung: .rst
MIME-Type: text/x-rst
Entwickelt von: David Goodger
Erstveröffentlichung: 2. April 2002
Art: Vereinfachte Auszeichnungssprache
Website: https://docutils.sourceforge.io/rst.html


Hintergrund

Der reStructuredText-Parser i​st eine Komponente d​er Docutils, e​iner in d​er Programmiersprache Python entwickelten Textverarbeitungsbibliothek. Version 0.6 unterstützt d​ie Umwandlung i​n ODT, Manpage, S5, XHTML, XML s​owie LaTeX. Letzteres ermöglicht e​inen professionellen Schriftsatz m​it Exportmöglichkeiten n​ach PostScript u​nd PDF. Die aktuelle Version v​on Docutils i​st 0.18.1 (vom 23. Dezember 2021).[1]

reStructuredText findet verbreitet Einsatz i​n der Formatierung d​er docstrings, d​er Python-typischen Kommentare z​ur Programmdokumentation. Das Software-Dokumentationswerkzeug Sphinx n​utzt reStructuredText. Zudem bieten einige Wiki-Systeme n​eben ihrer eigenen Wiki-Syntax reStructuredText a​ls Alternative an.

GitHub, Bitbucket u​nd GitLab unterstützen reST.

Vergleichbare leichte Auszeichnungssprachen s​ind z. B. Markdown, Textile u​nd AsciiDoc.

Syntaxbeispiele

Überschriften:

Abschnitt
=========
Unterabschnitt
--------------

Aufzählungslisten:

- Erster Punkt
- Zweiter Punkt
  - Ein Unterpunkt
- Dritter Punkt


1) Ein Punkt einer nummerierten Liste
2) Zweitens...
   a) Unterpunkt einer nummerierten Liste
      i) Noch eine Ebene tiefer...
3) Dritter Punkt der nummerierten Liste

Benannte Hyperlinks:

Dieser Satz dient zur Demonstration_ von `Hyperlinks in reST`_.
.. _Demonstration: http://de.wiki.li/Demonstration
.. _Hyperlinks in reST: http://docutils.sourceforge.net/docs/user/rst/quickref.html#hyperlink-targets

Anonyme Hyperlinks:

Ein Satz mit einem `anonymen Link auf die Python-Website`__.
__ http://www.python.org/

Fußnoten:

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

Einzelnachweise
  1. Docutils-Projektseite
This article is issued from Wikipedia. The text is licensed under Creative Commons - Attribution - Sharealike. The authors of the article are listed here. Additional terms may apply for the media files, click on images to show image meta data.