RST формат

Название документа / Субтитры

Заголовок всего документа отличается от заголовков разделов и может быть отформатирован несколько иначе (например, писатель HTML по умолчанию показывает его в виде центрированного заголовка).

Чтобы указать заголовок документа в reStructuredText, используйте уникальный стиль украшения в начале документа. Чтобы указать субтитры документа, используйте другой уникальный стиль оформления сразу после заголовка документа. Например:

================
 Document Title
================
----------
 Subtitle
----------

Section Title
=============

...

Обратите внимание, что надписи «Заголовок документа» и «Заголовок раздела» выше используют знаки равенства, но являются отдельными и не связанными стилями. Текст заглавных и подчеркнутых заголовков (но не только подчеркнутых) может быть вставлен для эстетики.

Разделы

  • # с надписью, для деталей
  • * с подчеркиванием, для глав
  • =, для разделов
  • -, for subsections
  • ^, для подразделов
  • ", для пунктов

Блок кода

Введите двойное двоеточие (:: ) и затем пустую строку, а затем хотя бы один пробел и, наконец, вы можете ввести свой код.

Также вы можете использовать `` ссылку на код`` с помощью `` `` .

выбор

  • `` ** жирный ** ``
  • `` * Курсивный * ``
  • `` `` Code```

Списки

  • * - не нумеруется
  • #. - нумерованный
  • 1,2,3, … - нумеруются