Dokumentation verfassen

Dokumentationserstellung

3. Dokumentation verfassen

Dokumentation in Markdown zu schreiben ist unkompliziert. In diesem Abschnitt geht es darum, wie Sie Markdown wirkungsvoll einsetzen, um gut strukturierte Dokumentation zu erstellen.

Praktische Übung

1. Dokumentation in Markdown schreiben:

   • Bearbeiten Sie die Datei index.md und ergänzen Sie Projektdetails und Anleitungen. Zum Beispiel:

     # Willkommen bei meinem Projekt
     
     Dies ist die Dokumentation meines Projekts. Hier finden Sie Hinweise zur Verwendung und Mitarbeit.
     

2. Markdown-Syntax erkunden:

   • Machen Sie sich mit der Markdown-Syntax vertraut, indem Sie Überschriften, Listen, Links und Bilder in Ihre Dateien index.md und about.md einfügen.

3. Vorschau der Dokumentation anzeigen:

   • Verwenden Sie erneut den Befehl mkdocs serve, um die aktualisierte Dokumentation im Browser anzusehen.