reStructuredText

reStructuredText ( сокращенно ReST , reST или RST ) - это упрощенный язык разметки , предназначенный для удобства чтения в чистом текстовом виде. Кроме того, reStructuredText должен легко конвертироваться в другие форматы.

задний план

Парсер reStructuredText является компонентом Docutils, библиотеки обработки текста, разработанной на языке программирования Python . Версия 0.6 поддерживает преобразование в ODT , manpage , S5 , XHTML , XML и LaTeX . Последний обеспечивает профессиональный набор текста с возможностью экспорта в PostScript и PDF . Текущая версия Docutils - 0.17.1 (по состоянию на 17 апреля 2021 г.).

reStructuredText широко используется при форматировании строк документации, типичных для Python комментариев к программной документации. Инструмент документации программного обеспечения Sphinx использует reStructuredText. Кроме того, некоторые системы вики предлагают reStructuredText в качестве альтернативы собственному синтаксису вики .

GitHub , Bitbucket и GitLab поддерживают reST.

К сопоставимым простым языкам разметки относятся, например, Б. Уценка , текстиль и AsciiDoc .

Примеры синтаксиса

Заголовки:

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

Маркированные списки:

- 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

Именованные гиперссылки :

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

Анонимные гиперссылки:

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

Сноски :

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

веб ссылки

Индивидуальные доказательства

  1. Страница проекта Docutils