WIP: Self Documetation

This commit is contained in:
John Haverlack 2025-11-11 10:13:52 -09:00
parent 622464b2e2
commit 0f22dc61fe
7 changed files with 45 additions and 15 deletions

View File

@ -13,12 +13,12 @@
"state": { "state": {
"type": "markdown", "type": "markdown",
"state": { "state": {
"file": "chapters/00_Introduction.md", "file": "chapters/02_Features.md",
"mode": "source", "mode": "source",
"source": false "source": false
}, },
"icon": "lucide-file", "icon": "lucide-file",
"title": "00_Introduction" "title": "02_Features"
} }
} }
] ]
@ -257,8 +257,11 @@
"obsidian-kanban:Create new board": false "obsidian-kanban:Create new board": false
} }
}, },
"active": "c8db6b72741a9d4b", "active": "6852f526864219b9",
"lastOpenFiles": [ "lastOpenFiles": [
"chapters/01_Getting_Started.md",
"chapters/02_Features.md",
"chapters/00_Introduction.md",
"conf/sedcoz12V", "conf/sedcoz12V",
"build/lib/diag", "build/lib/diag",
"build/lib/img/ACEP Logo for Canvas.png", "build/lib/img/ACEP Logo for Canvas.png",
@ -269,9 +272,6 @@
"build/lib/img/UAF.png", "build/lib/img/UAF.png",
"build/lib/img/UAFLogo_A_black.png", "build/lib/img/UAFLogo_A_black.png",
"build/lib/img/UAFLogo_A_blue.png", "build/lib/img/UAFLogo_A_blue.png",
"chapters/02_Chapter2.md",
"chapters/01_Chapter1.md",
"chapters/00_Introduction.md",
"README.md", "README.md",
"build/b3.epub", "build/b3.epub",
"build/Paths-to-Perception.epub", "build/Paths-to-Perception.epub",
@ -283,7 +283,6 @@
"build/b3.tex", "build/b3.tex",
"build/Paths-to-Perception.tex", "build/Paths-to-Perception.tex",
"build/Paths-to-Perception.html", "build/Paths-to-Perception.html",
"build/conf/style.css",
"build/lib/img/unit-circle-with-tau.png", "build/lib/img/unit-circle-with-tau.png",
"build/lib/img/unit-circle-with-pi.png.png", "build/lib/img/unit-circle-with-pi.png.png",
"pm/Book Action Items.md", "pm/Book Action Items.md",

View File

@ -151,7 +151,17 @@ window.MathJax = {
<li><a href="#new-concepts">New Concepts</a></li> <li><a href="#new-concepts">New Concepts</a></li>
</ul></li> </ul></li>
</ul></li> </ul></li>
<li><a href="#best-words-ever">Best Words Ever</a></li> <li><a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#installing-pre-requisites">Installing Pre-Requisites</a>
<ul>
<li><a href="#required">Required</a></li>
<li><a href="#optional">Optional</a></li>
</ul></li>
<li><a href="#editing-the-configuration">Editing the
Configuration</a></li>
<li><a href="#editing-the-content">Editing the Content</a></li>
</ul></li>
<li><a href="#example-content">Example Content</a> <li><a href="#example-content">Example Content</a>
<ul> <ul>
<li><a href="#si-conversion-factors">SI Conversion Factors</a></li> <li><a href="#si-conversion-factors">SI Conversion Factors</a></li>
@ -229,8 +239,12 @@ class="math display"><em>E</em><sup>2</sup>=<em>m</em><sub>0</sub><sup>2</
<p><strong>Alerts</strong></p> <p><strong>Alerts</strong></p>
<p> Extreme Highlight</p> <p> Extreme Highlight</p>
</div> </div>
<h1 id="best-words-ever">Best Words Ever</h1> <h1 id="getting-started">Getting Started</h1>
<p>Blah blah blah</p> <h2 id="installing-pre-requisites">Installing Pre-Requisites</h2>
<h3 id="required">Required</h3>
<h3 id="optional">Optional</h3>
<h2 id="editing-the-configuration">Editing the Configuration</h2>
<h2 id="editing-the-content">Editing the Content</h2>
<h1 id="example-content">Example Content</h1> <h1 id="example-content">Example Content</h1>
<p>In <span class="math inline"><em>R</em><em>ν</em></span> the <a <p>In <span class="math inline"><em>R</em><em>ν</em></span> the <a
href="https://en.wikipedia.org/wiki/Planck_units#Planck_length">Planck href="https://en.wikipedia.org/wiki/Planck_units#Planck_length">Planck

Binary file not shown.

View File

@ -1,3 +0,0 @@
# Best Words Ever
Blah blah blah

View File

@ -0,0 +1,20 @@
# Getting Started
## Installing Pre-Requisites
### Required
### Optional
## Editing the Configuration
## Editing the Content

View File

@ -1,8 +1,8 @@
# pandoc.yaml # pandoc.yaml
input-files: input-files:
- chapters/00_Introduction.md - chapters/00_Introduction.md
- chapters/01_Chapter1.md - chapters/01_Getting_Started.md
- chapters/02_Chapter2.md - chapters/02_Features.md
- chapters/Terminology.md - chapters/Terminology.md
- chapters/Citations.md - chapters/Citations.md