mdfile « ◉ » mdtoc

Markdown-Verzeichnis einfügen

Erstellt am 13.02.2024 Lesedauer ≤ 1 Min.

Präprozessor-Funktion

Fügt alle Dateien aus dem gewählten Verzeichnis in die aktuelle Datei ein.

  • Dem übergebenen Dateipfad wird der Markdown-Basispfad des Projekts vorangestellt.
  • Ein in der Datei enthaltener Yaml-Header wird ignoriert.
  • Sowohl die gesamte Einfügung, als auch jede einzelne Datei wird mit einem Abschnitt <div class="…">…</div> umschlossen.
  • Werden keine Klassen übergeben, wird für alle Abschnitte die Zuordnung als Klasse vergeben.
  • Wird eine Klasse übergeben (k1), gilt diese für die Datei-Abschnitte.
  • Werden zwei Klassen übergeben, gilt die erste (k1) für den umschließenden, die zweite (k2) für die Datei-Abschnitte.
  • Innerhalb der dadurch temporär erzeugten Markdown-Datei muss die Zuordnung eindeutig sein.

Definition

$$$ mddir zuordnung [k1] [k2] : relativer Pfad $$$
Zuordnung

Eindeutiger Bezeichner der Funktion

Klassen (k1,k2) (optional)
Nur k1

Der Klassen-name für das umschließende <DIV> der Dateien.

K1 und k2

k1 Umschließt alle eingefügten Dateien, k2 die einzelnen Dateien

relativer Pfad

Der Pfad zum Verzeichnis der Markdown-Dateien, ausgehend vom Quellverzeichnis des Projekts, typischerweise ist das .Projekte\Projektname\md

Es findet keine Kontrolle statt, ob es sich bei den eingefügten Dateien tatsächlich um Markdown-Dateien handelt.

mdfile « ◉ » mdtoc