MD-till-RST-konverterare

En MD-fil är ett plain text-dokument som innehåller Markdown, ett lättviktigt markup-språk skapat av John Gruber och Aaron Swartz. Formatet använder icke-alfabetiska tecken (såsom hashtags för headers och asterisker för betoning) för att definiera formaterings-syntax som är läsbar för människor i sin råa form och enkelt konverterbar till giltig XHTML eller HTML. Det är de facto-standarden för dokumentation i version control-system som Git.

Som strikt plain text kan MD-filer öppnas och redigeras i vilken grundläggande text editor som helst, såsom Microsoft Notepad eller Apple TextEdit. För en renderad förhandsgranskning av formateringen rekommenderas specialiserade editors som Obsidian, Typora eller Visual Studio Code.

En RST (reStructuredText)-fil är en plain text-fil som innehåller markup-syntax definierad av Docutils-projektet, primärt använd för teknisk dokumentation i programmeringsekosystemet Python (PEP 287). Den använder en lättviktig, indenteringskänslig syntax för att definiera dokumentstruktur, hyperlänkar och formatering, som är utformad för att vara läsbar i rå form men tillräckligt kraftfull för att kompilera till HTML, LaTeX eller PDF via dokumentationsgeneratorn Sphinx.

Som ett plain text-format kan RST-filer öppnas och redigeras med vilken text editor som helst, inklusive Visual Studio Code, Vim eller Notepad++. För att se den renderade dokumentlayouten som avsett måste filen dock bearbetas av en parser såsom docutils (med kommandon som rst2html) eller byggas inom en Sphinx-projektmiljö.