feat: minor additions based on first real-world use.

juananpe · Apr 3, 2024 · 72881e4 · 72881e4
1 parent 242edc8
commit 72881e4
Show file tree

Hide file tree

Showing 28 changed files with 490 additions and 22 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,5 @@
+# Contributing
+
+Contributions are very welcome.
+Please file issues or submit pull requests in our GitHub repository.
+All contributors will be acknowledged.
diff --git a/README.md b/README.md
@@ -109,5 +109,11 @@ A template for [Ark][ark]-based tutorials.
     1.  Add `fixme` shortcode for notes.
     1.  Add target to `lib/mccole/mccole.mk` to build zip file and to check things after unpacking it.
 
+1.  Adding features after trying it out.
+    1.  Add contributors' guide in `CONTRIBUTING.md` and page in `src/contrib/index.md`.
+    1.  Add MathJax to `lib/mccole/templates/head.html`.
+    1.  Add link to home page to `lib/mccole/templates/foot.html`.
+    1.  Add colored sidebars to `lib/mccole/resources/mccole.css`.
+    1.  Add stamp colors and Danielle Navarro to colophon.
 [ark]: https://www.dmulholl.com/docs/ark/main/
 [glosario]: https://glosario.carpentries.org/
diff --git a/config.py b/config.py
@@ -17,6 +17,7 @@
 appendices = [
     "license",
     "conduct",
+    "contrib",
     "bib",
     "glossary",
     "colophon",

diff --git a/docs/bib/index.html b/docs/bib/index.html
@@ -6,15 +6,30 @@
 <link rel="icon" href="../logo.svg">
 <link rel="stylesheet" href="../mccole.css" type="text/css">
 <title>McCole Template &middot; Bibliography</title>
+<script>
+  MathJax = {
+    tex: {
+      inlineMath: [['\\(', '\\)']]
+    }
+  };
+</script>
+<script
+  type="text/javascript"
+  id="MathJax-script"
+  async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js">
+</script>
+
 
   </head>
   <body>
     <main>
-      <h1>Bibliography</h1>
+
+<h1>Bibliography</h1>
+
 
       <div class="row notex">
   <div class="col-1 left">
-    <a href="../conduct/">&lArr;</a>
+    <a href="../contrib/">&lArr;</a>
   </div>
   <div class="col-10 center">
 
@@ -39,6 +54,8 @@ <h1>Bibliography</h1>
     <footer>
   © 2024 <a href="https://third-bit.com/">Greg Wilson</a>
   &middot;
+  <a href="../">home</a>
+  &middot;
   <a href="https://github.com/gvwilson/mccole">repository</a>
   &middot;
   <a href="../license/">license</a>

diff --git a/docs/colophon/index.html b/docs/colophon/index.html
@@ -6,11 +6,26 @@
 <link rel="icon" href="../logo.svg">
 <link rel="stylesheet" href="../mccole.css" type="text/css">
 <title>McCole Template &middot; Colophon</title>
+<script>
+  MathJax = {
+    tex: {
+      inlineMath: [['\\(', '\\)']]
+    }
+  };
+</script>
+<script
+  type="text/javascript"
+  id="MathJax-script"
+  async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js">
+</script>
+
 
   </head>
   <body>
     <main>
-      <h1>Colophon</h1>
+
+<h1>Colophon</h1>
+
 
       <div class="row notex">
   <div class="col-1 left">
@@ -43,14 +58,22 @@ <h1>Colophon</h1>
 <p>The site is built using <a href="https://www.dmulholl.com/docs/ark/main/">Ark</a> and hosted on <a href="https://pages.github.com/">GitHub Pages</a>.</p>
 </li>
 <li>
-<p>Traffic statistics are collected using <a href="https://plausible.io/">plausible.io</a>,
+<p>Traffic statistics are collected using <a href="https://plausible.io/">Plausible</a>,
     which provides a lightweight ethical alternative to surveillance capitalism.</p>
 </li>
+<li>
+<p>The colors in this theme
+    are lightened versions of those used in <a href="https://third-bit.com/colophon/">classic Canadian postage stamps</a>.
+    The art in the title is by <a href="https://art.djnavarro.net/">Danielle Navarro</a>
+    and used with her gracious permission.</p>
+</li>
 </ul>
     </main>
     <footer>
   © 2024 <a href="https://third-bit.com/">Greg Wilson</a>
   &middot;
+  <a href="../">home</a>
+  &middot;
   <a href="https://github.com/gvwilson/mccole">repository</a>
   &middot;
   <a href="../license/">license</a>

diff --git a/docs/conduct/index.html b/docs/conduct/index.html
@@ -6,11 +6,26 @@
 <link rel="icon" href="../logo.svg">
 <link rel="stylesheet" href="../mccole.css" type="text/css">
 <title>McCole Template &middot; Code of Conduct</title>
+<script>
+  MathJax = {
+    tex: {
+      inlineMath: [['\\(', '\\)']]
+    }
+  };
+</script>
+<script
+  type="text/javascript"
+  id="MathJax-script"
+  async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js">
+</script>
+
 
   </head>
   <body>
     <main>
-      <h1>Code of Conduct</h1>
+
+<h1>Code of Conduct</h1>
+
 
       <div class="row notex">
   <div class="col-1 left">
@@ -20,7 +35,7 @@ <h1>Code of Conduct</h1>
 
   </div>
   <div class="col-1 right">
-    <a href="../bib/">&rArr;</a>
+    <a href="../contrib/">&rArr;</a>
   </div>
 </div>
 
@@ -87,6 +102,8 @@ <h2>Attribution</h2>
     <footer>
   © 2024 <a href="https://third-bit.com/">Greg Wilson</a>
   &middot;
+  <a href="../">home</a>
+  &middot;
   <a href="https://github.com/gvwilson/mccole">repository</a>
   &middot;
   <a href="../license/">license</a>

diff --git a/docs/contrib/index.html b/docs/contrib/index.html
@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<link rel="icon" href="../logo.svg">
+<link rel="stylesheet" href="../mccole.css" type="text/css">
+<title>McCole Template &middot; Contributing</title>
+<script>
+  MathJax = {
+    tex: {
+      inlineMath: [['\\(', '\\)']]
+    }
+  };
+</script>
+<script
+  type="text/javascript"
+  id="MathJax-script"
+  async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js">
+</script>
+
+
+  </head>
+  <body>
+    <main>
+
+<h1>Contributing</h1>
+
+
+      <div class="row notex">
+  <div class="col-1 left">
+    <a href="../conduct/">&lArr;</a>
+  </div>
+  <div class="col-10 center">
+
+  </div>
+  <div class="col-1 right">
+    <a href="../bib/">&rArr;</a>
+  </div>
+</div>
+
+
+
+      <p>Contributions are very welcome.
+Please file issues or submit pull requests in our GitHub repository.
+All contributors will be acknowledged.</p>
+    </main>
+    <footer>
+  © 2024 <a href="https://third-bit.com/">Greg Wilson</a>
+  &middot;
+  <a href="../">home</a>
+  &middot;
+  <a href="https://github.com/gvwilson/mccole">repository</a>
+  &middot;
+  <a href="../license/">license</a>
+</footer>
+
+  </body>
+</html>
diff --git a/docs/finale/index.html b/docs/finale/index.html
@@ -6,11 +6,26 @@
 <link rel="icon" href="../logo.svg">
 <link rel="stylesheet" href="../mccole.css" type="text/css">
 <title>McCole Template &middot; Conclusion</title>
+<script>
+  MathJax = {
+    tex: {
+      inlineMath: [['\\(', '\\)']]
+    }
+  };
+</script>
+<script
+  type="text/javascript"
+  id="MathJax-script"
+  async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js">
+</script>
+
 
   </head>
   <body>
     <main>
-      <h1>Conclusion</h1>
+
+<h1>Conclusion</h1>
+
 
       <div class="row notex">
   <div class="col-1 left">
@@ -32,7 +47,7 @@ <h1>Conclusion</h1>
 
       <ul>
 <li>Reference to introduction <a href="../intro/">Chapter&nbsp;1</a></li>
-<li>Reference to glossary <a href="../glossary/">Appendix&nbsp;D</a></li>
+<li>Reference to glossary <a href="../glossary/">Appendix&nbsp;E</a></li>
 <li>Reference to figure in another file <a class="fig-ref" href="../intro/#intro_concept_map">Figure&nbsp;1.1</a></li>
 <li>Reference to table in this file <a class="tbl-ref" href="../finale/#finale_table">Table&nbsp;2.1</a></li>
 </ul>
@@ -61,6 +76,8 @@ <h1>Conclusion</h1>
     <footer>
   © 2024 <a href="https://third-bit.com/">Greg Wilson</a>
   &middot;
+  <a href="../">home</a>
+  &middot;
   <a href="https://github.com/gvwilson/mccole">repository</a>
   &middot;
   <a href="../license/">license</a>

diff --git a/docs/glossary/index.html b/docs/glossary/index.html
@@ -6,11 +6,26 @@
 <link rel="icon" href="../logo.svg">
 <link rel="stylesheet" href="../mccole.css" type="text/css">
 <title>McCole Template &middot; Glossary</title>
+<script>
+  MathJax = {
+    tex: {
+      inlineMath: [['\\(', '\\)']]
+    }
+  };
+</script>
+<script
+  type="text/javascript"
+  id="MathJax-script"
+  async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js">
+</script>
+
 
   </head>
   <body>
     <main>
-      <h1>Glossary</h1>
+
+<h1>Glossary</h1>
+
 
       <div class="row notex">
   <div class="col-1 left">
@@ -33,6 +48,8 @@ <h1>Glossary</h1>
     <footer>
   © 2024 <a href="https://third-bit.com/">Greg Wilson</a>
   &middot;
+  <a href="../">home</a>
+  &middot;
   <a href="https://github.com/gvwilson/mccole">repository</a>
   &middot;
   <a href="../license/">license</a>

diff --git a/docs/index.html b/docs/index.html
@@ -6,11 +6,27 @@
 <link rel="icon" href="logo.svg">
 <link rel="stylesheet" href="mccole.css" type="text/css">
 <title>McCole Template</title>
+<script>
+  MathJax = {
+    tex: {
+      inlineMath: [['\\(', '\\)']]
+    }
+  };
+</script>
+<script
+  type="text/javascript"
+  id="MathJax-script"
+  async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js">
+</script>
+
 
   </head>
   <body>
     <main>
-      <h1>McCole Template</h1>
+
+<h1>McCole Template</h1>
+
+
 
       <div class="row notex">
   <div class="col-1 left">
@@ -27,11 +43,13 @@ <h1>McCole Template</h1>
 
 
       <ol class="toc-chapters"><li><a href="intro/">Introduction</a></li><li><a href="finale/">Conclusion</a></li></ol>
-<ol class="toc-appendices"><li><a href="license/">License</a></li><li><a href="conduct/">Code of Conduct</a></li><li><a href="bib/">Bibliography</a></li><li><a href="glossary/">Glossary</a></li><li><a href="colophon/">Colophon</a></li></ol>
+<ol class="toc-appendices"><li><a href="license/">License</a></li><li><a href="conduct/">Code of Conduct</a></li><li><a href="contrib/">Contributing</a></li><li><a href="bib/">Bibliography</a></li><li><a href="glossary/">Glossary</a></li><li><a href="colophon/">Colophon</a></li></ol>
     </main>
     <footer>
   © 2024 <a href="https://third-bit.com/">Greg Wilson</a>
   &middot;
+  <a href="#">home</a>
+  &middot;
   <a href="https://github.com/gvwilson/mccole">repository</a>
   &middot;
   <a href="license/">license</a>

diff --git a/docs/intro/index.html b/docs/intro/index.html
@@ -6,11 +6,26 @@
 <link rel="icon" href="../logo.svg">
 <link rel="stylesheet" href="../mccole.css" type="text/css">
 <title>McCole Template &middot; Introduction</title>
+<script>
+  MathJax = {
+    tex: {
+      inlineMath: [['\\(', '\\)']]
+    }
+  };
+</script>
+<script
+  type="text/javascript"
+  id="MathJax-script"
+  async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js">
+</script>
+
 
   </head>
   <body>
     <main>
-      <h1>Introduction</h1>
+
+<h1>Introduction</h1>
+
 
       <div class="row notex">
   <div class="col-1 left">
@@ -28,7 +43,7 @@ <h1>Introduction</h1>
 <li>Best way to learn design is through examples.</li>
 <li>All material is available under open licenses, and all royalties go to charity.</li>
 </ul>
-      <p class="terms">Terms Defined: 
+      <p class="terms">Terms defined: 
 <a class="gl-ref" href="../glossary/#gl:ssg" markdown="1">static site generator</a>
 </p>
       <ul>
@@ -47,6 +62,8 @@ <h1>Introduction</h1>
     <footer>
   © 2024 <a href="https://third-bit.com/">Greg Wilson</a>
   &middot;
+  <a href="../">home</a>
+  &middot;
   <a href="https://github.com/gvwilson/mccole">repository</a>
   &middot;
   <a href="../license/">license</a>