Dieses Tool wandelt Markdown in RST um, also in reStructuredText für Sphinx, Read the Docs und PyPI: Überschriften mit Unterstreichung, code-block-Direktiven, Grid Tables, Admonitions und Fußnoten. Eine README.md einfügen und die .rst-Fassung kopieren.
Zuletzt aktualisiert:
So funktioniert’s
Markdown einfügen
Eine README oder Dokumentationsseite einfügen, eine .md-Datei öffnen oder das Beispiel laden.
Konventionen wählen
Unterstreichungszeichen der Überschriftenebenen, Direktive für Codeblöcke, Tabellenstil und Link-Stil festlegen.
.rst verwenden
Als README.rst herunterladen oder den Text direkt ins Sphinx-Projekt übernehmen.
Funktionen
Gültige Abschnittsstruktur
RST leitet die Ebenen aus der Reihenfolge der Unterstreichungsstile ab. Übersprungene Markdown-Ebenen werden zusammengezogen, damit kein „Title level inconsistent“ auftritt.
Direktiven statt Behelfslösungen
Code wird zu .. code-block:: python, Hinweise zu .. note:: oder .. warning::, Formeln zu .. math::.
Drei Tabellenstile
Grid Table, Simple Table oder die list-table-Direktive, die sich am leichtesten nachbearbeiten lässt.
Regeln für Inline-Markup beachtet
Wo RST Leerraum um **fett** oder `Links`__ verlangt, werden maskierte Leerzeichen eingefügt.
Grenzen & Datenschutz
Dateien bis 10 MB werden verarbeitet, Eingaben über 256 KB in einem Web Worker, sodass die Seite flüssig bleibt. Nichts wird hochgeladen: Die Umwandlung läuft im Browser, und „Von URL öffnen“ holt die Datei direkt von der angegebenen Adresse.
Unterschiede zu beachten
reStructuredText kennt weder Durchstreichen noch Unterstreichen; solcher Text bleibt unformatiert. Harte Zeilenumbrüche werden zu Line Blocks mit führendem |. Ein Übergang (––) darf ein Dokument weder eröffnen noch beenden und wird an diesen Stellen entfernt. Grid und Simple Tables haben keine Spaltenausrichtung. Den Rückweg bietet RST in Markdown.
Mehr zum Datenschutz auf der Datenschutzseite.
Häufige Fragen
Wie wird aus README.md eine README.rst?
README.md hier öffnen und das Ergebnis als README.rst herunterladen. Die Warnungen zeigen, was sich in RST nicht abbilden lässt.
Braucht PyPI noch reStructuredText?
Nein, PyPI stellt auch Markdown dar. Sphinx-Projekte und viele ältere Werkzeuge erwarten aber RST.
Passen die Unterstreichungen bei Überschriften mit Umlauten?
Ja. Die Länge der Linie richtet sich nach der Zeichenbreite des Titels, nicht nach Bytes – „Übersicht“ erhält genau neun Zeichen. Dasselbe gilt für die Spalten von Grid Tables.
Warum geht Fettdruck in einem Link verloren?
reStructuredText kann Inline-Markup nicht verschachteln. Der Linktext bleibt erhalten, die innere Formatierung entfällt mit einer Warnung.
Wie werden Bilder im Fließtext geschrieben?
Über Substitutionen: |name| im Text und eine Definition .. |name| image:: am Ende.
Lässt sich RST zurück in Markdown wandeln?
Ja, mit RST in Markdown, verlinkt über dem Ergebnis.