Jeśli tworzysz dokumentację w ekosystemie Pythona - na przykład w generatorze Sphinx - potrzebujesz formatu reStructuredText (RST). Gdy treść napisałeś w wygodniejszym Markdown, konwersja MD na RST przeniesie ją do właściwej składni.

Markdown a RST

  • Markdown - prosty, powszechny, świetny do szybkiego pisania.
  • RST - bogatszy składniowo, standard dokumentacji Pythona i Sphinx.

Kiedy przyda się MD na RST?

  • Projekt lub dokumentacja wymaga RST.
  • Migrujesz treść z bloga/README (Markdown) do systemu opartego na Sphinx.
  • Chcesz skorzystać z zaawansowanych funkcji RST, zaczynając od gotowego tekstu w Markdown.

Co zostanie zachowane?

Konwersja zamienia elementy Markdown na odpowiedniki RST: nagłówki, listy, linki, pogrubienia i bloki kodu. Otrzymujesz gotowy plik .rst do dalszej pracy.

Prywatność

Konwersja dokumentów odbywa się w całości lokalnie w Twojej przeglądarce, więc Twoje pliki nie są nigdzie wysyłane.