reStructuredText

reStructuredText ( ReST , reST sau RST pe scurt ) este un limbaj de markup simplificat , cu scopul de a fi citit în special în forma de text pur. În plus, reStructuredText ar trebui să fie ușor convertibil în alte formate.

fundal

Parserul reStructuredText este o componentă a Docutils, o bibliotecă de procesare de text dezvoltată în limbajul de programare Python . Versiunea 0.6 acceptă conversia în ODT , pagina de manual , S5 , XHTML , XML și LaTeX . Acesta din urmă permite tipărirea profesională cu opțiuni de export în PostScript și PDF . Versiunea actuală a Docutils este 0.17.1 (începând cu 17 aprilie 2021).

reStructuredText este utilizat pe scară largă în formatarea șirurilor de documente, comentariile tipice Python la documentația programului. Sphinx instrument de documentare , software - ul utilizează reStructuredText. În plus, unele sisteme wiki oferă text reStructured ca alternativă la propria sintaxă wiki .

GitHub , Bitbucket și GitLab acceptă reST.

Limbajele de marcare ușoare comparabile sunt de ex. B. Markdown , Textile și AsciiDoc .

Exemple de sintaxă

Titluri:

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

Liste cu marcatori:

- 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

Numit hyperlink - uri :

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

Hiperlinkuri anonime:

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

Note de subsol :

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

Link-uri web

Dovezi individuale

  1. Pagina proiectului Docutils