Markdown zu reStructuredText

Verwandeln Sie Markdown-Dokumente in reStructuredText (RST) für Python-Dokumentation, Sphinx-Projekte und Read the Docs.

Jetzt konvertieren

Funktionen

Sphinx-Kompatibilität

Generiert RST-Code, der direkt mit Sphinx verarbeitet werden kann für professionelle Dokumentation.

Tabellen-Konvertierung

Markdown-Tabellen werden in RST-Grid-Tables oder Simple-Tables konvertiert.

Code-Block-Directives

Code-Blöcke werden in .. code-block:: Directives umgewandelt mit Sprachangabe.

Admonition-Support

Blockquotes und besondere Markdown-Elemente werden in RST-Admonitions konvertiert.

Referenz-Konvertierung

Markdown-Links und -Bilder werden in RST-Referenzen und Inline-Images umgewandelt.

Docstring-Export

Unterstützt Python-Docstring-Format für die Einbettung in Docstrings.

Unterstützte Formate

EINGABE

Markdown

Standard-Markdown mit GFM-Erweiterungen

AUSGABE

reStructuredText

RST für Sphinx, Read the Docs und Python

Eingabe (Markdown)

# Dokumentation

## Installation

```bash
pip install mein-paket
```

| Schritt | Aktion |
|---|---|
| 1 | Installation |
| 2 | Konfiguration |

> **Hinweis:** Lesen Sie die Anleitung.

Ausgabe (RST)

=============
Dokumentation
=============

Installation
------------

.. code-block:: bash

    pip install mein-paket

.. list-table::
   :header-rows: 1

   * - Schritt
     - Aktion
   * - 1
     - Installation
   * - 2
     - Konfiguration

.. note::

   Lesen Sie die Anleitung.

Anwendungsbereiche

Sphinx-Dokumentation

Erstellen Sie professionelle Python-Projektdokumentation mit Sphinx.

Read the Docs

Hosten Sie Ihre Dokumentation automatisch auf Read the Docs.

Python-Pakete

Schreiben Sie Dokumentation für PyPI-Pakete und Bibliotheken.

Tech-Blogs

Erstellen Sie technische Blog-Artikel im RST-Format für Pelican oder andere Generatoren.

Häufig gestellte Fragen

Ist das Ergebnis Sphinx-kompatibel?

Ja, das generierte RST ist vollständig kompatibel mit Sphinx und kann direkt in Ihre Dokumentation integriert werden.

Welche Tabellenformate werden unterstützt?

Wir bieten Grid-Tables (Standard) und Simple-Tables. Grid-Tables bieten mehr Flexibilität, Simple-Tables sind kompakter.

Kann ich Code-Blöcke mit Syntax-Highlighting exportieren?

Ja, Code-Blöcke werden als .. code-block:: Directives exportiert. Die Sprache wird aus dem Markdown-Code-Block extrahiert.

Was passiert mit Fußnoten?

Markdown-Fußnoten werden in RST-Fußnoten-Syntax konvertiert mit automatischer Nummerierung.

Kann ich Inline-Markup konvertieren?

Ja, Inline-Code, Fett, Kursiv und Links werden korrekt in RST-Inline-Markup umgewandelt.

Funktioniert das für Python-Docstrings?

Ja, das Format ist kompatibel mit Google-Style, NumPy-Style und Standard-Google-Docstrings.