Markdown in reStructuredText umwandeln

Erzeuge reStructuredText-Quelltext für Sphinx- und docutils-Projekte. Gängige Strukturen werden übertragen; Sphinx-Rollen, Direktiven und projektspezifische Verweise ergänzt du anschließend.

Markdown-Eingabe

259 Zeichen

RST-Vorschau

Konvertierter Text
Projektnotizen
==============

Ein übersichtliches Dokument beginnt mit einer **klaren Struktur**.

Darauf kommt es an
------------------

* Verständliche Überschriften
* Funktionierende Links
* Dateien, die sich weiterbearbeiten lassen

    Prüfe vor dem Download die gerenderte Vorschau.
Dateien werden in diesem Browser-Tab verarbeitet.

Markdown als RST vorbereiten

Die Ausgabe ist eine Migrationshilfe und kein Ersatz für einen Build im Zielprojekt.

01

Markdown bereinigen

Prüfe Überschriften, verschachtelte Listen, Tabellen, Links und Codeblöcke.

02

RST kontrollieren

Achte auf Unterstreichungen, Einrückungen, Tabellenbreite und Linkziele.

03

Mit Sphinx bauen

Speichere die .rst-Datei und teste sie mit den Erweiterungen und Warnoptionen deines Projekts.

Python-Dokumentation

Markdown-Struktur in RST-Syntax

Gängige Dokumentelemente werden in reStructuredText übertragen.

ÜberschriftenAbschnittsebenen erhalten RST-typische Unterstreichungen.
Listen und CodeAufzählungen, nummerierte Listen und Codeblöcke werden passend eingerückt.
Links und TabellenEinfache Verweise und Tabellen werden in eine weiterbearbeitbare RST-Form überführt.
Geeignet für

Inhalte für Sphinx und docutils vorbereiten

Python-Projekte

Migriere vorhandene README- oder Leitfadeninhalte in eine RST-basierte Dokumentation.

API-Handbücher

Nutze die Grundstruktur und ergänze anschließend Sphinx-Direktiven und Querverweise.

Bestehende Builds

Passe Markdown-Inhalte an einen Ablauf an, der ausschließlich .rst-Dateien verarbeitet.

Häufige Fragen

Häufige Fragen

Kann ich die Datei direkt in Sphinx verwenden?

Die Grundstruktur ist dafür gedacht. Ergänze projektspezifische Rollen, Direktiven, Labels und Querverweise und führe einen Build mit Warnungen aus.

Was bedeutet RST?

RST steht für reStructuredText, eine Auszeichnungssprache, die häufig in Python- und Sphinx-Dokumentationen verwendet wird.

Bleiben Markdown-Erweiterungen erhalten?

Nur wenn eine sinnvolle RST-Entsprechung vorhanden ist. Plattformabhängige Erweiterungen benötigen eine eigene Lösung.