Этот конвертер Markdown в RST переписывает текст в reStructuredText для Sphinx, Read the Docs и PyPI: заголовки с подчеркиванием, директивы code-block, сеточные таблицы, примечания и сноски. Вставьте README.md и скопируйте .rst.
Обновлено:
Как это работает
Вставьте Markdown
Вставьте README или страницу документации, откройте файл .md или нажмите «Загрузить пример».
Выберите соглашения
Символы подчеркивания заголовков, директива для кода, стиль таблиц и стиль ссылок.
Используйте .rst
Скачайте README.rst или вставьте текст в свой проект Sphinx.
Возможности
Корректная структура разделов
В RST уровни определяются порядком стилей подчеркивания, поэтому пропущенные уровни Markdown сдвигаются — и ошибки «Title level inconsistent» не возникает.
Директивы вместо обходных путей
Код становится .. code-block:: python, примечания — .. note:: или .. warning::, формулы — .. math::.
Три стиля таблиц
Сеточные таблицы, простые таблицы или директива list-table, которую проще всего редактировать.
Правила строчной разметки соблюдены
Там, где RST требует пробелов вокруг **жирного** или `ссылок`__, вставляются экранированные пробелы.
Ограничения и конфиденциальность
Файлы до 10 MB. Тексты больше 256 KB конвертируются в фоновом потоке, поэтому страница не зависает. Ничего не загружается на сервер: конвертация идет в вашем браузере, а «Открыть по ссылке» скачивает файл напрямую с указанного адреса. Подробнее — на странице о конфиденциальности.
Различия, о которых стоит помнить
В reStructuredText нет зачеркивания и подчеркивания — такой текст остается обычным. Принудительные переносы строк становятся блоками строк (строки с |). Разделитель (––) не может открывать или завершать документ, поэтому там он удаляется. У сеточных и простых таблиц нет выравнивания столбцов.
Частые вопросы
Как перевести README.md в README.rst?
Откройте здесь README.md и скачайте результат как README.rst. Посмотрите предупреждения: в них перечислено то, что RST передать не может.
Нужен ли PyPI формат RST?
Нет, PyPI отображает и Markdown, но проекты Sphinx и многие старые инструменты ждут reStructuredText.
Почему пропадает жирный текст внутри ссылки?
В reStructuredText нельзя вкладывать строчную разметку. Текст ссылки сохраняется, а внутреннее форматирование убирается с предупреждением.
Как записываются изображения внутри текста?
Через подстановки: |name| в тексте и определение .. |name| image:: в конце.
Сохранится ли кириллица в заголовках?
Да, русский текст переносится без изменений.
Можно ли перевести RST обратно в Markdown?
Да, для этого есть конвертер RST → Markdown — ссылка на него над результатом.