MkDocs konfigurieren

Dokumentationserstellung

2. MkDocs konfigurieren

Die Datei mkdocs.yml ist die Konfigurationsdatei Ihres MkDocs-Projekts. Sie legt Struktur, Theme und weitere Einstellungen Ihrer Dokumentationswebsite fest.

Praktische Übung

1. Datei mkdocs.yml bearbeiten:

   • Öffnen Sie die Datei mkdocs.yml in einem Texteditor und nehmen Sie Änderungen vor, zum Beispiel:
     • Den Namen der Website festlegen:

       site_name: Meine Projektdokumentation
       

     • Ein Theme hinzufügen, zum Beispiel:

       theme:
         name: material
       

     • Seiten zur Dokumentationsstruktur hinzufügen:

       nav:
         - Startseite: index.md
         - Über das Projekt: about.md
       

2. Weitere Markdown-Dateien erstellen:

   • Erstellen Sie im Verzeichnis docs/ eine neue Datei mit dem Namen about.md und fügen Sie etwas Inhalt hinzu:

     # Über dieses Projekt
     
     Dieses Projekt zeigt, wie MkDocs mit GitLab CI/CD eingesetzt wird.
     

3. Dokumentation bauen:

   • Nachdem Sie die Konfiguration angepasst und neue Inhalte hinzugefügt haben, führen Sie den folgenden Befehl aus, um die statische Website zu bauen:

     mkdocs build