choice « ◉ » mddir

Markdown-Datei einfügen

Erstellt am 13.02.2024 Aktualisiert am 30.10.2024 Lesedauer ≤ 1 Min.

Präprozessor-Funktion

Fügt eine referenzierte Markdown-Datei aus dem Projekt-Markdown-Verzeichnis ein.

  • Dem übergebenen Dateipfad wird der Markdown-Basispfad des Projekts vorangestellt.
  • Ein in der Datei enthaltener Yaml-Header wird ignoriert.
  • Die eingefügte Datei wird mit einem Abschnitt <div class="…">…</div> umschlossen.
  • Wird eine Klasse übergeben, wird diese verwendet, andernfalls erhält der Abschnitt eine Klasse mit dem Namen der Zuordnung.
  • Innerhalb der dadurch temporär erzeugten Markdown-Datei muss die Zuordnung eindeutig sein.

Definition

$$$ mdfile zuordnung  [klasse] : Quelldatei-Pfad\Dateiname $$$
Zuordnung

Eindeutiger Bezeichner der Funktion

Klasse (optional)

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

Quelldatei-Pfad\Dateiname

Der Pfad zur Markdown-Datei ausgehend vom Quellverzeichnis des Projekts, typischerweise ist das .Projekte\Projektname\md

Hierfür gibt es den Menübefehl DateiProjektverweis, mit der Auswahl Quelle ⟨→ Import⟩, typischerweise ist das .md.

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

choice « ◉ » mddir