Contents

Markdown File Manager (mdfm)

Die Teil-Website http://jbusse.de/gendifs wird mit Jupyterbook auf Basis von derzeit 35 einzelnen Markdown-Dateien aufgebaut. Einen eigentlich zusammengehörenden Text in 35 einzelnen Dateien zu pflegen stellt sich zunehmend als nervig bis unmöglich heraus.

Die Idee besteht darin, einen Markdown File Manager zu bauen, der in 2 Richtungen arbeitet:

mdfm-collect

Gegeben:

  • eine Liste von Verzeichnissen, in denen sich Markdown-Dateien und ggf. auch _toc.yml-Dateien befinden.

Gesucht:

  • alle md-Dateien zusammengefügt zu einer einzelnen md-Datei Alles.md

  • mit internen Datei-Trennern

  • sowie Metadaten, wo jeder einzelne Abschnitt herkommt

mdfm-distribute

Gegeben:

  • Eine einzelne md-Datei Alles.md

  • sowie Metadaten, wo jeder einzelne Abschnitt hinkommen soll

Gesucht:

  • zurückspielen der in Alles.md enthaltenen Daten in die Quellverzeichnisse

  • incl. Anlegen von Backups für die zurückgespielten Dateien

Ziele

Minimalziel ist, …

  • alle Markdown-Dateien aus bestimmten Verzeichnissen als eine einzige Datei Alles.md bearbeiten zu können.

Interessant wird es,

  • die Integrität der Datei Alles.md zu überprüfen: Haben alle Querverweise ein Ziel? etc.

  • aufgrund von Metadaten in den Datei-Trennern automatisch Strukturinformationen wie z.B. _toc.yml-Dateien zu generieren