1. Ausführen der Migrations-Engine

Führen Sie den folgenden Befehl im Stammverzeichnis Ihres bestehenden MkDocs-Projekts aus:

npx @docmd/core migrate --mkdocs

pnpm dlx @docmd/core migrate --mkdocs

yarn dlx @docmd/core migrate --mkdocs

bunx @docmd/core migrate --mkdocs

Was automatisch passiert

2. Vorschau der Migrations-Ausgabe

Zeigen Sie Ihre Inhalte sofort in docmd an:

npx @docmd/core dev

pnpm dlx @docmd/core dev

yarn dlx @docmd/core dev

bunx @docmd/core dev

3. Manuelle Konfiguration & Erweiterungs-Zuordnung

MkDocs verwendet mkdocs.yml, um die Navigationsstruktur und PyMdown-Erweiterungen zu definieren. Übersetzen Sie jedes benutzerdefinierte Setup in docmd-Container.

Navigations-Einrichtung

nav:-Blöcke auf oberster Ebene in mkdocs.yml werden automatisch in das navigation-Array von docmd übersetzt. Wenn Sie erweiterte Navigationsfunktionen benötigen (z. B. benutzerdefinierte Icons oder externe URLs), erstellen Sie eine navigation.json in Ihrem docs/-Ordner:

nav:
  - Home: index.md
  - Guide:
    - Setup: setup.md
    - Usage: usage.md

[
  {
    "title": "Home",
    "path": "/"
  },
  {
    "title": "Guide",
    "collapsible": true,
    "children": [
      { "title": "Setup", "path": "/setup" },
      { "title": "Usage", "path": "/usage" }
    ]
  }
]

Ersetzen von Python-Markdown-Erweiterungen

Konvertieren Sie die MkDocs PyMdown-Erweiterungssyntax in die nativen Container von docmd.

Konvertierung von Admonitions

MkDocs verwendet die !!!-Block-Syntax, die eine Konvertierung in das :::-Format erfordert.

MkDocs (PyMdown):

!!! note "Optionaler Titel"
    Dies ist ein Admonition-Inhaltsblock.

docmd:

::: callout info "Optionaler Titel"
Dies ist ein Admonition-Inhaltsblock.
:::

Konvertierung von Tabs

MkDocs (SuperFences):

=== "Tab 1"
    Inhalt für Tab 1.

=== "Tab 2"
    Inhalt für Tab 2.

docmd:

::: tabs
== tab "Tab 1"
Inhalt für Tab 1.

== tab "Tab 2"
Inhalt für Tab 2.
:::