Konwerter RST na Markdown zamienia reStructuredText (Sphinx, docutils, pliki README z PyPI) na GitHub Flavored Markdown: sekcje, bloki kodu, tabele siatkowe i proste, bloki uwag, przypisy i linki. Wystarczy wkleić tekst .rst i skopiować wynik.
Ostatnia aktualizacja:
Jak to działa
Wklej RST
README.rst, stronę dokumentacji Sphinx albo dowolny plik .rst można wkleić, otworzyć lub zacząć od przykładu.
Ustal styl Markdownu
Bloki uwag (note, warning…) jako alerty GitHub lub cytaty, znacznik listy, wyróżnienie i znacznik bloku kodu.
Kopiuj Markdown
Wynik pasuje do GitHuba, MkDocs, Docusaurusa lub migracji do MyST; podgląd pokazuje, jak się wyrenderuje.
Funkcje
Poziomy sekcji jak w docutils
Poziom nagłówka wynika z kolejności, w jakiej po raz pierwszy pojawiają się style podkreśleń i nadkreśleń – dokładnie tak, jak ustala to docutils.
Wszystkie rodzaje bloków
Dyrektywy code-block, code i sourcecode, bloki literalne po ::, bloki doctest, bloki linii i cytaty z atrybucją.
Tabele
Tabele siatkowe, proste (z wierszami kontynuacji) oraz dyrektywy list-table i csv-table stają się tabelami Markdown.
Rozwiązane odwołania
Nazwane i anonimowe cele hiperłączy, osadzone adresy URI, podstawienia z obrazami oraz przypisy numerowane ręcznie i automatycznie.
Limity i prywatność
Pliki do 10 MB; dane wejściowe większe niż 256 KB są konwertowane w wątku roboczym (Web Worker). Nic nie jest wysyłane na serwer: konwersja odbywa się w przeglądarce, a „Otwórz z adresu URL” pobiera plik bezpośrednio spod wpisanego adresu. Więcej na stronie o prywatności.
Ograniczenia
Dyrektywy include i odsyłacze Sphinx wymagają pełnego projektu, dlatego nie są rozwiązywane. Z wielowierszowego nagłówka tabeli tylko pierwszy wiersz zostaje nagłówkiem w Markdownie. Listy pól (field lists) zamieniają się w pogrubione terminy z opisem. Konwersję odwrotną zapewnia Markdown na RST.
Najczęstsze pytania
Jak przekonwertować RST na Markdown bez pandoc?
Wystarczy wkleić tutaj reStructuredText i skopiować wynik – nie trzeba instalować ani pandoc, ani Pythona.
Jak zamienić README.rst na README.md?
Wystarczy otworzyć README.rst, sprawdzić podgląd i kliknąć „Pobierz .MD”, a potem w razie potrzeby zmienić nazwę pobranego pliku na README.md.
Co z dyrektywami Sphinx, np. toctree?
toctree, autodoc i include wymagają całego projektu, więc są pomijane, a ostrzeżenie wymienia każdą z nich z nazwy.
Czy bloki note i warning są obsługiwane?
Tak: note, tip, important, warning, caution, danger, hint, seealso i ogólne admonition stają się alertami GitHub lub cytatami.
Co z rolami :ref: i :doc:?
Odsyłacze zamieniają się w swój tekst, a :code:, :math:, :sup: i :sub: zachowują znaczenie.
Czy działa konwersja Markdown na RST?
Tak – konwerter Markdown na RST jest podlinkowany nad wynikiem.