cagix / pandoc-lecture

Pandoc Markdown Lecture Template: This project defines a skeleton repo for creating lecture slides and handouts including lecture notes out of Pandoc Markdown (https://pandoc.org/MANUAL.html) using a single source approach.
MIT License
97 stars 18 forks source link

[Action] Export as GitHub-Markdown (gfm) #160

Open cagix opened 1 year ago

cagix commented 1 year ago

Add an additional build target to make the content available as GitHub markdown (gfm).

GH-Markdown has additional new syntax for math: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions ... this should resolve some cases where "traditional" math (using $ or $$) is not being recognised properly. Define a custom Lua filter, but maybe Pandoc does support this out of the box now (e.g. https://github.com/jgm/pandoc/pull/9156).

support for boxes could be done via "gh markdown alerts" (https://github.com/orgs/community/discussions/16925).

replace \operatorname{x} w/ \mathop{\text{x}} (see https://github.com/github/markup/issues/1688)


Release als GitHub-Markdown (als Branch einchecken, von Readme aus verlinken) analog zu _slides und _hugo

GH-Markdown kann mittlerweile sogar MathJax, d.h. man müsste die Toolchain so anpassen, dass Abbildungen skaliert werden und Referenzen aufgelöst werden. Ggf. braucht man hier noch ein eigenes Markdown-Template, um die einzelnen Bausteine in der richtigen Reihenfolge zu haben.

Damit könnte man sich das Skript in "nüchtern" direkt im GH ansehen.