Add md2html.cfg to bin/README.md

This commit is contained in:
Cody Boone Ferguson committed 2024-06-16 05:54:25 -07:00
1 parent 6793e2210c
commit 75a58a9fca
2 files changed
+44 -2

No files matched your search

+26 -1
View File
@@ -379,6 +379,31 @@ We recommend that this tool be invoked via the top level `Makefile` by:
``` ```
<div id="md2html_cfg">
### [md2html.cfg](%%REPO_URL%%/bin/md2html.cfg)
</div>
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.
```
<div id="md2html"> <div id="md2html">
### [md2html.sh](%%REPO_URL%%/bin/md2html.sh) ### [md2html.sh](%%REPO_URL%%/bin/md2html.sh)
</div> </div>
@@ -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 (permanent markdown files or temporarily generated
markdown files) and HTML fragments from the [inc directory](../inc/index.html). 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. used by [md2html.sh](%%REPO_URL%%/bin/md2html.sh) to drive the generation process.
+18 -1
View File
@@ -575,13 +575,30 @@ do that, that is not a problem.</p>
<pre><code> bin/gen-years.sh -v 1</code></pre> <pre><code> bin/gen-years.sh -v 1</code></pre>
<p>We recommend that this tool be invoked via the top level <code>Makefile</code> by:</p> <p>We recommend that this tool be invoked via the top level <code>Makefile</code> by:</p>
<pre><code> make gen_years</code></pre> <pre><code> make gen_years</code></pre>
<div id="md2html_cfg">
<h3 id="md2html.cfg"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.cfg">md2html.cfg</a></h3>
</div>
<p>This is a configuration file for the <a href="index.html#md2html">md2html</a> tool.
Although a configuration file it is also something of a script file.</p>
<p>To not down descend into the depths of <code>pandoc(1)</code> and to have to explain how
this file can change all the HTML files, we advise you to let
<a href="https://www.glyphweb.com/arda/s/smaug.html">Smaug</a> (the dragon of
<a href="https://www.glyphweb.com/arda/e/erebor.html">Erebor</a>), famously visited by a
<a href="https://www.glyphweb.com/arda/h/hobbits.html">Hobbit</a> and 13
<a href="https://www.glyphweb.com/arda/d/dwarves.html">Dwarves</a> in the
<a href="https://www.glyphweb.com/arda/t/thirdage.html">T.A.</a> 2941 or 1341
in the <a href="https://www.glyphweb.com/arda/s/shirereckoning.html">Shire-reckoning</a>, slumber as
“here be dragons”. If you still need convincing, we wish to remind you of <a href="https://www.glyphweb.com/arda/b/bilbobaggins.html">Bilbo
Baggins</a>’ famous words:</p>
<pre><code> &quot;Never laugh at live dragons, Bilbo you fool!&quot; he said to himself, and it
became a favourite saying of his later, and passed into a proverb.</code></pre>
<div id="md2html"> <div id="md2html">
<h3 id="md2html.sh"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.sh">md2html.sh</a></h3> <h3 id="md2html.sh"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.sh">md2html.sh</a></h3>
</div> </div>
<p>This is the primary tool that forms IOCCC generated HTML content from <p>This is the primary tool that forms IOCCC generated HTML content from
markdown files (permanent markdown files or temporarily generated markdown files (permanent markdown files or temporarily generated
markdown files) and HTML fragments from the <a href="../inc/index.html">inc directory</a>.</p> markdown files) and HTML fragments from the <a href="../inc/index.html">inc directory</a>.</p>
<p>The <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.cfg">bin/md2html.cfg</a> configuration file is <p>The <a href="index.html#md2html_cfg">md2html.cfg</a> configuration file is
used by <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.sh">md2html.sh</a> to drive the generation process.</p> used by <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.sh">md2html.sh</a> to drive the generation process.</p>
<div id="output-index-author"> <div id="output-index-author">
<h3 id="output-index-author.sh"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/output-index-author.sh">output-index-author.sh</a></h3> <h3 id="output-index-author.sh"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/output-index-author.sh">output-index-author.sh</a></h3>