simplify toc&comment management w/ mdbook-header-footer

SichangHe · Sep 13, 2024 · a4be277 · a4be277
1 parent d415a75
commit a4be277
Show file tree

Hide file tree

Showing 116 changed files with 40 additions and 141 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -16,7 +16,7 @@ jobs:
           lfs: true
       - uses: cargo-bins/cargo-binstall@main
       - name: Install mdBook, mdBook-KaTeX, and mdBook-ToC
-        run: cargo binstall -y mdbook mdbook-katex mdbook-toc
+        run: cargo binstall -y mdbook mdbook-katex mdbook-toc mdbook-header-footer
       - name: Install minify-html
         run: |
           curl -LO https://github.com/wilsonzlin/minify-html/releases/download/v0.15.0/minhtml-0.15.0-x86_64-unknown-linux-gnu

diff --git a/book.toml b/book.toml
@@ -27,10 +27,36 @@ level = 1
 copy-js = false
 runnable = false
 
+[preprocessor.header-footer]
+headers = [{ padding = "<!-- toc -->\n" }]
+footers = [
+    { regex = "^blogs/", padding = """
+
+[*Steven Hé (Sīchàng)'s Blogs*](/blogs/)
+
+<script src="https://giscus.app/client.js" data-repo="SichangHe/sichanghe.github.io" data-repo-id="R_kgDOJoD14g"
+    data-category="General" data-category-id="DIC_kwDOJoD14s4CflYo" data-mapping="title" data-strict="1"
+    data-reactions-enabled="1" data-emit-metadata="0" data-input-position="top" data-theme="preferred_color_scheme"
+    data-lang="en" data-loading="lazy" crossorigin="anonymous" async>
+    </script>
+""" },
+    { regex = "^news/", padding = """
+
+[*News | Steven Hé (Sīchàng)*](/news/)
+
+<script src="https://giscus.app/client.js" data-repo="SichangHe/sichanghe.github.io" data-repo-id="R_kgDOJoD14g"
+    data-category="General" data-category-id="DIC_kwDOJoD14s4CflYo" data-mapping="title" data-strict="1"
+    data-reactions-enabled="1" data-emit-metadata="0" data-input-position="top" data-theme="preferred_color_scheme"
+    data-lang="en" data-loading="lazy" crossorigin="anonymous" async>
+    </script>
+""" },
+]
+before = ["links", "toc"]
+
+[preprocessor.toc]
+before = ["katex"]
+
 [preprocessor.katex]
 after = ["links"]
 include-src = true
 throw-on-error = false
-
-[preprocessor.toc]
-before = ["katex"]
diff --git a/linked/JSphere b/linked/JSphere
diff --git a/src/about.md b/src/about.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # About
 
 ## Contact

diff --git a/src/blogs/300x_speed_up.md b/src/blogs/300x_speed_up.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # ~300× Speed Up in Rust: Finding Inexact Matches in Nested Sets
 
 I optimized my route analyzer to get 300× faster.
@@ -501,8 +500,6 @@ prefixes][flamegraph-use-routes-for-each-as]][flamegraph-use-routes-for-each-as]
 
 Started *2024-05-30*, finished *2024-07-29*.
 
-{{ #include footer.md }}
-
 [Cargo-FlameGraph]: https://github.com/flamegraph-rs/flamegraph
 [flamegraph-after]: https://github.com/SichangHe/internet_route_verification/assets/84777573/33a7354f-a47a-4c8f-a905-c717bbd38f62
 [flamegraph-before]: https://github.com/SichangHe/internet_route_verification/assets/84777573/6a869975-a764-45f8-9f14-a27498f3e1f8

diff --git a/src/blogs/deprecated/how_did_we.md b/src/blogs/deprecated/how_did_we.md
@@ -1,5 +1,3 @@
-<!-- toc -->
-
 # How did we get here? WordPress?
 
 This was when I set up the blog in WordPress.

diff --git a/src/blogs/deprecated/index.md b/src/blogs/deprecated/index.md
@@ -1,5 +1,3 @@
-<!-- toc -->
-
 # Deprecated
 
 These entries are stored only for the history.
diff --git a/src/blogs/footer.md b/src/blogs/footer.md
diff --git a/src/blogs/index.md b/src/blogs/index.md
@@ -1,5 +1,3 @@
-<!-- toc -->
-
 <div style="display: flex; align-items: center;">
     <img alt="Steven Hé (Sīchàng)'s avatar" style="width: calc(100% - 30em); height: auto; max-width: 100%;"
         src="/favicon.svg" />

diff --git a/src/blogs/learning_async_rust_wrong.md b/src/blogs/learning_async_rust_wrong.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # We are Learning Async Rust Wrong
 <!-- TODO: Change to "I was?" -->
 

diff --git a/src/blogs/perfect_grayscale.md b/src/blogs/perfect_grayscale.md
@@ -1,5 +1,3 @@
-<!-- toc -->
-
 # Creating Perfect Grayscale-Gradient Colormaps
 
 <style>
@@ -208,5 +206,3 @@ Can you solve the system for $r,g,b$ given $h,s,p$?
 ---
 
 *2024-05-25*
-
-{{ #include footer.md }}
diff --git a/src/blogs/what_does_mdbook.md b/src/blogs/what_does_mdbook.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 
 # What an mdBook Preprocessor Does—Code Walk-through of mdBook-KaTeX
 
@@ -304,5 +303,3 @@ We will talk about the mess mdBook-KaTeX was in next time.
 ---
 
 *2023-05-27*, edited: *2023-06-11*, *2024-05-24*
-
-{{ #include footer.md }}
diff --git a/src/blogs/why_was_mdbook.md b/src/blogs/why_was_mdbook.md
@@ -1,5 +1,3 @@
-<!-- toc -->
-
 <!-- TODO: This is a draft. -->
 
 # Why Was mdBook-KaTeX in a Mess and How did I Clean It Up—Celebrating mdBook-KaTeX v0.5

diff --git a/src/diary/back_from_duke.md b/src/diary/back_from_duke.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Back from Duke
 
 20230313

diff --git a/src/diary/elixir_phoenix.md b/src/diary/elixir_phoenix.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Elixir Phoenix
 
 I need a back end technology.

diff --git a/src/diary/feeling_lost.md b/src/diary/feeling_lost.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Feeling Lost
 
 2022-05-15

diff --git a/src/diary/index.md b/src/diary/index.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Diary
 
 Guests: don't read this. This is private.
diff --git a/src/diary/linux_vm_and_neovim.md b/src/diary/linux_vm_and_neovim.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Linux VM And Neovim
 
 20220806

diff --git a/src/diary/mdbook_katex.md b/src/diary/mdbook_katex.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # `mdbook-katex`
 
 20230315

diff --git a/src/diary/spring_2024_activities/index.md b/src/diary/spring_2024_activities/index.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Spring 2024 Activities
 
 *2023-03-28*

diff --git a/src/diary/spring_2024_ideas.md b/src/diary/spring_2024_ideas.md
@@ -1,2 +1 @@
-<!-- toc -->
 # Spring 2024 Ideas
diff --git a/src/diary/spring_2024_ideas/rethinking_the_web.md b/src/diary/spring_2024_ideas/rethinking_the_web.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Rethinking The Web
 
 ## Browser space

diff --git a/src/diary/spring_2024_ideas/rust.md b/src/diary/spring_2024_ideas/rust.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Rust
 
 ## Threads & Async & Coroutines & Lunatics

diff --git a/src/diary/start.md b/src/diary/start.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # start
 
 *2022-03-17*

diff --git a/src/diary/the_run.md b/src/diary/the_run.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # The Run
 
 2022-05-08

diff --git a/src/diary/vscodium.md b/src/diary/vscodium.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # VSCodium
 
 *2022-04-04*

diff --git a/src/giscus.md b/src/giscus.md
diff --git a/src/index.md b/src/index.md
@@ -1,5 +1,3 @@
-<!-- toc -->
-
 # Steven Hé (Sīchàng)
 
 <div

diff --git a/src/news/2024fall.md b/src/news/2024fall.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 <!-- markdownlint-disable-file first-line-h1 -->
 ### 2024 Fall
 

diff --git a/src/news/2024spring.md b/src/news/2024spring.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 <!-- markdownlint-disable-file first-line-h1 -->
 ### 2024 Spring
 

diff --git a/src/notes/automation_software/cli_util.md b/src/notes/automation_software/cli_util.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Command-Line Utilities
 
 wrap lines to a maximum width of 80 in FILE

diff --git a/src/notes/automation_software/hammerspoon.md b/src/notes/automation_software/hammerspoon.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Hammerspoon
 
 add stuff: open config, type in LaTeX, save, reload config

diff --git a/src/notes/automation_software/index.md b/src/notes/automation_software/index.md
@@ -1,2 +1 @@
-<!-- toc -->
 # Automation Software
diff --git a/src/notes/class_notes/cs201.md b/src/notes/class_notes/cs201.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Introduction to Programming and Data Structures
 
 **encryption**

diff --git a/src/notes/class_notes/cs301.md b/src/notes/class_notes/cs301.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Algorithms and Databases
 
 # sort

diff --git a/src/notes/class_notes/cs304.md b/src/notes/class_notes/cs304.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Speech Recognition
 
 broader speech processing

diff --git a/src/notes/class_notes/cs310.md b/src/notes/class_notes/cs310.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Introduction to Databases
 
 information: data with meaning

diff --git a/src/notes/class_notes/cs401.md b/src/notes/class_notes/cs401.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Cloud Computing
 
 operational expense (OPEX), capital expense (CAPEX) → centralize server

diff --git a/src/notes/class_notes/cs402.md b/src/notes/class_notes/cs402.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Artificial Intelligence
 
 most supervised learning when ppl talk about

diff --git a/src/notes/class_notes/csci651.md b/src/notes/class_notes/csci651.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Advanced Computer Networking
 
 40 paper + 20hr+ programming project + similar research project

diff --git a/src/notes/class_notes/csci670.md b/src/notes/class_notes/csci670.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Advanced Analysis of Algorithms
 
 6hw + 3qz + 2 theoretical thinking project

diff --git a/src/notes/class_notes/index.md b/src/notes/class_notes/index.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Unstructured Class Notes
 
 some of these are generated from old `docx` file using Pandoc
diff --git a/src/notes/class_notes/math202.md b/src/notes/class_notes/math202.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Linear Algebra
 
 linear system: $\left\{\begin{array}{r}

diff --git a/src/notes/class_notes/math205.md b/src/notes/class_notes/math205.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Probability and Statistics
 
 ⌊*x*⌋= the greatest integer smaller than *x*

diff --git a/src/notes/class_notes/stats210.md b/src/notes/class_notes/stats210.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Probability, Random Variables, and Stochastic Processes
 
 ## joint distribution: discrete

diff --git a/src/notes/cs/discrete_math.md b/src/notes/cs/discrete_math.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Discrete Mathematics for Computer Science
 
 ## proof by induction

diff --git a/src/notes/cs/index.md b/src/notes/cs/index.md
@@ -1,2 +1 @@
-<!-- toc -->
 # Computer Science
diff --git a/src/notes/cs/machine_learning.md b/src/notes/cs/machine_learning.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Machine Learning
 
 ## general problem format
@@ -451,4 +450,4 @@ $K$ is a kernel of $\{\vec x_i\}$
     K(\vec x,\vec\xi)=e^{-\frac{\|\vec x-\vec\xi\|^2}{\sigma^2}}
     $$
 
-    - radial basis function (RBF) SVM
+    - radial basis function (RBF) SVM
diff --git a/src/notes/cs/networking.md b/src/notes/cs/networking.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Networking
 
 # encoding/decoding

diff --git a/src/notes/data_science/index.md b/src/notes/data_science/index.md
@@ -1,2 +1 @@
-<!-- toc -->
 # Data Science
diff --git a/src/notes/data_science/visualization.md b/src/notes/data_science/visualization.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Visualization
 
 # data type

diff --git a/src/notes/documentation/index.md b/src/notes/documentation/index.md
@@ -1,2 +1 @@
-<!-- toc -->
 # Documentation
diff --git a/src/notes/documentation/pandoc.md b/src/notes/documentation/pandoc.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Pandoc
 
 [How to use Pandoc to produce a research paper](https://opensource.com/article/18/9/pandoc-research-paper)

diff --git a/src/notes/exams/index.md b/src/notes/exams/index.md
@@ -1,2 +1 @@
-<!-- toc -->
 # Exams
diff --git a/src/notes/exams/toefl.md b/src/notes/exams/toefl.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # TOEFL
 
 ## reading

diff --git a/src/notes/index.md b/src/notes/index.md
@@ -1,2 +1 @@
-<!-- toc -->
 # Steven Hé (Sīchàng)'s Notes
diff --git a/src/notes/macos/index.md b/src/notes/macos/index.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # macOS
 
 get ID of app:

diff --git a/src/notes/macos/sucklessfy.md b/src/notes/macos/sucklessfy.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Sucklessfy
 
 allow apps from anywhere

diff --git a/src/notes/mathematics/abstract_algebra.md b/src/notes/mathematics/abstract_algebra.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Abstract Algebra
 
 # integer

diff --git a/src/notes/mathematics/analysis.md b/src/notes/mathematics/analysis.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Real Analysis
 
 # set
@@ -812,4 +811,4 @@ $$
 
 - $f(x)\in C^∞ (x_0-R,x_0+R)$
 - $f'(x)=\sum_{j=0}^∞ (a_j(x-x_0)^j)'$
-- $\sum_{j=0}^∞ a_j(x-x_0)^j$ is Taylor series of $f$ about $x_0$
+- $\sum_{j=0}^∞ a_j(x-x_0)^j$ is Taylor series of $f$ about $x_0$
diff --git a/src/notes/mathematics/arithmetics.md b/src/notes/mathematics/arithmetics.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Arithmetics
 
 $$

diff --git a/src/notes/mathematics/calculus.md b/src/notes/mathematics/calculus.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Calculus
 
 # function

diff --git a/src/notes/mathematics/complex_analysis.md b/src/notes/mathematics/complex_analysis.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Complex Analysis
 
 # complex number $\mathbb C$

diff --git a/src/notes/mathematics/complex_function.md b/src/notes/mathematics/complex_function.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Complex function
 
 # logarithm

diff --git a/src/notes/mathematics/complex_sequence_series.md b/src/notes/mathematics/complex_sequence_series.md
@@ -1,4 +1,3 @@
-<!-- toc -->
 # Complex Sequence and Series
 
 # sequence