Merge pull request #524 from Witiko/feat/first-class-yaml

Add first-class support for YAML documents
Witiko · Oct 28, 2024 · 4fa44cd · 4fa44cd
2 parents 4c4138b + 62b7d64
commit 4fa44cd
Show file tree

Hide file tree

Showing 6 changed files with 445 additions and 81 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -17,6 +17,11 @@ Development:
 
  [matrix-514]: https://matrix.to/#/!UeAwznpYwwsinVTetR:matrix.org/$TTc-m7B5NSdsLBNNyIuFWQ-u2nOZ03lJ5js88hnyFiU?via=matrix.org&via=im.f3l.de
 
+- Add first-class support for YAML documents. (#452, #473, #524)
+  - Add plain TeX macros `\yamlSetup`, `\yamlInput`, `\yamlBegin`, and `\yamlEnd`.
+  - Add LaTeX environment `yaml` and redefine command `\yamlInput` for LaTeX.
+  - Add ConTeXt commands `\setupyaml`, `\inputyaml`, `\startyaml`, and `\stopyaml`.
+
 Documentation:
 
 - Document LaTeX hooks. (#464, #507)

diff --git a/Makefile b/Makefile
@@ -157,7 +157,7 @@ $(LIBRARIES): force
 # This target typesets the manual.
 $(TECHNICAL_DOCUMENTATION): $(DTXARCHIVE) $(TECHNICAL_DOCUMENTATION_RESOURCES)
 	latexmk -silent $< || (cat $(basename $@).log 1>&2; exit 1)
-	test `tail $(basename $<).log | sed -rn 's/.*\(([0-9]*) pages.*/\1/p'` -ge 380
+	test `tail $(basename $<).log | sed -rn 's/.*\(([0-9]*) pages.*/\1/p'` -ge 450
 
 # This pseudotarget continuously typesets the manual.
 preview: $(DTXARCHIVE) $(TECHNICAL_DOCUMENTATION_RESOURCES)

diff --git a/examples/context-mkiv.tex b/examples/context-mkiv.tex
@@ -57,6 +57,37 @@
 
 \starttext
 
+% Set and typeset the document metadata using a YAML metadata block.
+\setupyaml
+  [
+    jekyllDataRenderers = {
+      title = {\gdef\doctitle{#1}},
+      author = {\gdef\author{#1}},
+      date = {\gdef\date{#1}},
+    },
+    renderers = {
+      jekyllDataEnd = {%
+        \startalignment[center]
+          \blank[force,2*big]
+            {\tfd \doctitle}
+          \blank[3*medium]
+            {\tfa \author}
+          \blank[2*medium]
+            {\tfa \date}
+          \blank[3*medium]
+        \stopalignment
+      },
+    },
+  ]
+
+\startyaml
+
+title:  An Example *Markdown* Document
+author: Vít Starý Novotný
+date:   `\currentdate`{=tex}
+
+\stopyaml
+
 % Typeset the document `example.md` by letting the Markdown package handle
 % the conversion internally. Optionally, we can specify additional options
 % between the square brackets similarly to the command `\setupmarkdown`.

diff --git a/examples/latex-luatex.tex b/examples/latex-luatex.tex
@@ -12,7 +12,6 @@
   fencedCode,
   hashEnumerators,
   inlineNotes,
-  jekyllData,
   lineBlocks,
   notes,
   pipeTables,
@@ -28,13 +27,11 @@
   texMathSingleBackslash,
 ]{markdown}
 % Set the document metadata using a YAML metadata block.
-\begin{markdown}[hybrid]
----
+\begin{yaml}
 title:  An Example *Markdown* Document
 author: Vít Starý Novotný
-date:   \today
----
-\end{markdown}
+date:   `\today`{=tex}
+\end{yaml}
 \begin{document}
 % Typeset the document `example.md` by letting the Markdown package handle
 % the conversion internally.

diff --git a/examples/latex-pdftex.tex b/examples/latex-pdftex.tex
@@ -13,7 +13,6 @@
   fencedCode,
   hashEnumerators,
   inlineNotes,
-  jekyllData,
   lineBlocks,
   notes,
   pipeTables,
@@ -29,13 +28,11 @@
   texMathSingleBackslash,
 ]{markdown}
 % Set the document metadata using a YAML metadata block.
-\begin{markdown}[hybrid]
----
+\begin{yaml}
 title:  An Example *Markdown* Document
 author: Vít Starý Novotný
-date:   \today
----
-\end{markdown}
+date:   `\today`{=tex}
+\end{yaml}
 \begin{document}
 % Typeset the document `example.md` by letting the Markdown package handle
 % the conversion internally.