Zum Inhalt

Diese Dokumentation bearbeiten

Die Dokumentation wurde mit MkDocs erstellt. Die Bearbeitung erfolgt über ein direktes Editieren der Markdown-Dateien.

Zur Erstellung fertigen HTML-Version muss über MkDocs ein Build-Prozess ausgeführt werden.

Arbeiten mit MkDocs

Am Laser-PC des Maker Space

text text text text text text text text text text text text text text text text text text text text text text


Zuhause bearbeiten

Zugang zum GitHub-Repository Für die Bearbeitung zuhause sollte das GitHub-Repository genutzt werden. Bitte wende dich an die zuständigen Personen für das FabLab, um einen Zugang zu erhalten.

MkDocs und Erweiterungen installieren

  1. Python installieren: https://www.python.org/downloads/
  2. Python Package Manger installieren
    1. Installationsskript runterladen: https://bootstrap.pypa.io/get-pip.py
    2. Installationsskript ausführen
  3. Im Terminal bzw. in der Powershell folgenden Befehl ausführen:
    pip install mkdocs mkdocs-material mdx_truly_sane_lists


Vorschau beim Bearbeiten

  1. Beileigende Batch-Datei mkdocs_serve.bat ausführen
  2. Die Vorschau ist im Browser erreichbar unter http://127.0.0.1:8000


Build-Prozess

  1. Beileigende Batch-Datei mkdocs_build.bat ausführen
  2. Die fertige HTML-Version befindet sich im Unterordner site

Markdown-Syntax

Du kannst dich beim Bearbeiten an den bestehenden Inhalten orientieren. Ein leichter Einstieg ist immer vorhandene Inhalte zu kopieren und abzuändern. Wenn du das tust, dann solltest du darauf achten, dass die Formatierung (z.B. Texteinrückung) gleich bleibt.

Breite von Bildern definieren

Bilder können in der Breite auf 40%/ 50%/ 60%/ 70%/ 80% der verfügbaren Fläche skaliert werden. Hierfür muss einfach die Bezeichnung img40/ img50/ img60/ img70/ img80 im Feld für die Bildbeschreibung eingetragen werden.

![img60](Grafik - Lasercutter.png) entspricht 60% Breite der verfügbaren Fläche

Empfohlene Software zur Bearbeitung

  • VSCode
  • VSCode-Erweiterungen
    • Markdown All in One
    • Markdown Table
    • Mermaid Markdown Syntax Highlighting
    • Mermaid Preview