From 75a58a9fcaba9fa5b264855da39ef3bcad345d77 Mon Sep 17 00:00:00 2001
From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com>
Date: Sun, 16 Jun 2024 05:54:25 -0700
Subject: [PATCH] Add md2html.cfg to bin/README.md
---
bin/README.md | 27 ++++++++++++++++++++++++++-
bin/index.html | 19 ++++++++++++++++++-
2 files changed, 44 insertions(+), 2 deletions(-)
diff --git a/bin/README.md b/bin/README.md
index adba7c69f..0a0f1fd03 100644
--- a/bin/README.md
+++ b/bin/README.md
@@ -379,6 +379,31 @@ We recommend that this tool be invoked via the top level `Makefile` by:
```
+
+### [md2html.cfg](%%REPO_URL%%/bin/md2html.cfg)
+
+
+This is a configuration file for the [md2html](index.html#md2html) tool.
+Although a configuration file it is also something of a script file.
+
+To not down descend into the depths of `pandoc(1)` and to have to explain how
+this file can change all the HTML files, we advise you to let
+[Smaug](https://www.glyphweb.com/arda/s/smaug.html) (the dragon of
+[Erebor](https://www.glyphweb.com/arda/e/erebor.html)), famously visited by a
+[Hobbit](https://www.glyphweb.com/arda/h/hobbits.html) and 13
+[Dwarves](https://www.glyphweb.com/arda/d/dwarves.html) in the
+[T.A.](https://www.glyphweb.com/arda/t/thirdage.html) 2941 or 1341
+in the [Shire-reckoning](https://www.glyphweb.com/arda/s/shirereckoning.html), slumber as
+"here be dragons". If you still need convincing, we wish to remind you of [Bilbo
+Baggins](https://www.glyphweb.com/arda/b/bilbobaggins.html)' famous words:
+
+
+```
+ "Never laugh at live dragons, Bilbo you fool!" he said to himself, and it
+ became a favourite saying of his later, and passed into a proverb.
+```
+
+
### [md2html.sh](%%REPO_URL%%/bin/md2html.sh)
@@ -387,7 +412,7 @@ This is the primary tool that forms IOCCC generated HTML content from
markdown files (permanent markdown files or temporarily generated
markdown files) and HTML fragments from the [inc directory](../inc/index.html).
-The [bin/md2html.cfg](%%REPO_URL%%/bin/md2html.cfg) configuration file is
+The [md2html.cfg](index.html#md2html_cfg) configuration file is
used by [md2html.sh](%%REPO_URL%%/bin/md2html.sh) to drive the generation process.
diff --git a/bin/index.html b/bin/index.html
index ff6a98820..e951a2af4 100644
--- a/bin/index.html
+++ b/bin/index.html
@@ -575,13 +575,30 @@ do that, that is not a problem.
bin/gen-years.sh -v 1
We recommend that this tool be invoked via the top level Makefile by:
make gen_years
+
+This is a configuration file for the md2html tool.
+Although a configuration file it is also something of a script file.
+To not down descend into the depths of pandoc(1) and to have to explain how
+this file can change all the HTML files, we advise you to let
+Smaug (the dragon of
+Erebor), famously visited by a
+Hobbit and 13
+Dwarves in the
+T.A. 2941 or 1341
+in the Shire-reckoning, slumber as
+“here be dragons”. If you still need convincing, we wish to remind you of Bilbo
+Baggins’ famous words:
+ "Never laugh at live dragons, Bilbo you fool!" he said to himself, and it
+ became a favourite saying of his later, and passed into a proverb.
This is the primary tool that forms IOCCC generated HTML content from
markdown files (permanent markdown files or temporarily generated
markdown files) and HTML fragments from the inc directory.
-The bin/md2html.cfg configuration file is
+
The md2html.cfg configuration file is
used by md2html.sh to drive the generation process.