Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tooling to create a single GFM file containg all lessons #293

Open
cagix opened this issue Sep 8, 2024 · 0 comments
Open

Tooling to create a single GFM file containg all lessons #293

cagix opened this issue Sep 8, 2024 · 0 comments

Comments

@cagix
Copy link
Owner

cagix commented Sep 8, 2024

Ähnlich wie in #291 soll aus den in Pandoc-Markdown (mit YAML) vorliegenden Lektionen ein GitHub-Markdown-basiertes File entstehen.

Dabei sollen aber alle Dateien in der korrekten Reihenfolge konkateniert werden. Es soll für die resultierende Datei ein Gesamtquellenverzeichnis geben.

Vermutliches Vorgehen:

  • Erstellen der Ausgangsdateien: Wie in Tooling to create GFM files per lesson #291 zunächst individuelle GFM-Dateien erstellen, aber ohne Quellenverzeichnis (letzten Schritt in Tooling to create GFM files per lesson #291 weglassen) => jede Lektion hat den richtigen Aufbau inkl. der Boxen für "TLDR" etc., aber noch kein Literaturverzeichnis (nur die Pandoc-Referenzen)
  • Erkennen der benötigten Dateien: Analog zum Warping-Filter rekursiv beginnend mit dem Readme alle lokalen Links auf Markdown-Dateien und Abbildungen ablaufen. Pro Ebene jeweils das Readme und die Markdowns in der Reihenfolge des Auftretens sowie die Ordner der nächsten Ebenenen speichern.
  • Variante 1
    • Über den entstehenden Baum die Header anpassen
    • Konkatenation per Makefile-Snippet (generieren lassen): pandoc readme.md ebeneA/readme.md ebeneA/file1.md ...
  • Variante 2
    • Eine Art Startdatei mit Links erzeugen (ala summary.md bei mdBook)
    • Mit Pandoc und einem der vorhandenen Include-Filter das Gesamtdokument erzeugen
  • Als letzten Schritt ggf. nochmal Citeproc zur Generierung des Literaturverzeichnisses

Fragen:

  • Was ist mit Abbildungen? Müssen die bewegt werden?
  • Was ist mit lokalen Links? Müssen die angepasst werden?
@cagix cagix changed the title Tooling to create a single GFM file containg alls lessons Tooling to create a single GFM file containg all lessons Sep 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

1 participant