Как конвертировать RST в MD
- Добавьте ваш файл .RST - перетащите его в поле выше или нажмите, чтобы выбрать.
- Конвертируйте его в .MD за несколько секунд.
- Скачайте ваш новый файл .MD.
Чего ожидать
- Заголовки, маркированные списки, ссылки и встроенный код конвертируются чисто; директивы RST (
.. note::,.. code-block::) и роли (:ref:,:func:) удаляются или заменяются приблизительно - проверяйте каждую директиву после конвертации. - Структура
.. toctree::не сохраняется; вам придется пересобрать оглавление вручную после конвертации. - Чтобы выбрать конкретный вариант Markdown, передайте
-t gfm(GitHub Flavored Markdown) или-t commonmarkв Pandoc.
Часто задаваемые вопросы
Является ли конвертация RST в Markdown потерей данных?
Нет. Базовый контент - заголовки, списки, ссылки, встроенный код - переносится, но директивы и роли RST не имеют эквивалентов в Markdown и теряются. Ручная доработка после конвертации - это норма.
В чем основная разница между RST и Markdown?
Оба являются языками разметки обычного текста, но RST имеет более богатую систему директив и ролей, предназначенную для структурированной документации (Sphinx). Markdown проще и чаще используется для файлов README и общих заметок.
Как конвертировать целую папку файлов RST?
Pandoc обрабатывает один файл за одну команду; в Linux или macOS используйте цикл:
for f in *.rst; do pandoc "$f" -o "${f%.rst}.md"; done.Как сохранить работоспособность документации Sphinx после перехода на Markdown?
Используйте MyST Markdown вместо обычного Markdown - MyST поддерживает директивы и роли в стиле RST, поэтому ваша сборка Sphinx продолжит работать.
