upgrade to markdown-it-mathjax

IntroToProgramming · Oct 24, 2024 · 02a8b2b · 02a8b2b
1 parent 06710de
commit 02a8b2b
Show file tree

Hide file tree

Showing 25 changed files with 317 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -1 +1 @@
-docs/intro.md
+docs/chapters/intro.md
diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js
@@ -2,32 +2,36 @@ module.exports = {
     title: '编程导引',
     themeConfig: {
         nav: [
-            {text: "编程导引", link: '/intro'},
+            {text: "编程导引", link: '/chapters/intro'},
+            {text: "参考", link: '/reference/glossary'},
         ],
 
-        sidebar: [
-            { text: "引言", link: "/intro" },
-            { text: "环境", link: '/ch01_environment' },
-            { text: "计算", link: '/ch02_computation' },
-            { text: "过程", link: '/ch03_procedure' },
-            { text: "编码", link: '/ch04_encoding' },
-            { text: "序列", link: '/ch05_sequence' },
-            { text: "数据", link: '/ch06_data' },
-            { text: "状态", link: '/ch07_state' },
-            { text: "引用", link: '/ch08_reference' },
-            { text: "闭包", link: '/ch09_closure' },
-            { text: "对象", link: '/ch10_object' },
-            { text: "并发", link: '/ch11_concurrency' },
-        ],
+        sidebar: {
+            "/chapters/": [
+                { text: "引言", link: "/chapters/intro" },
+                { text: "环境", link: '/chapters/ch01_environment' },
+                { text: "计算", link: '/chapters/ch02_computation' },
+                { text: "过程", link: '/chapters/ch03_procedure' },
+                { text: "编码", link: '/chapters/ch04_encoding' },
+                { text: "序列", link: '/chapters/ch05_sequence' },
+                { text: "数据", link: '/chapters/ch06_data' },
+                { text: "状态", link: '/chapters/ch07_state' },
+                { text: "引用", link: '/chapters/ch08_reference' },
+                { text: "闭包", link: '/chapters/ch09_closure' },
+                { text: "对象", link: '/chapters/ch10_object' },
+                { text: "并发", link: '/chapters/ch11_concurrency' }    
+            ],
+            "/reference/": [
+                { text: "概念解释", link: "/reference/glossary"}
+            ]
+        },
         footer: {
             copyright: "CC-BY 4.0 Licensed | Copyright © 2015-present Kimmy Leo"
         },
     },
 
     markdown: {
-        config: (md) => {
-            md.use(require('markdown-it-katex'))
-        }
+        math: true
     },
 
 
@@ -45,13 +49,6 @@ var _hmt = _hmt || [];
   s.parentNode.insertBefore(hm, s);
 })();
             `
-        ],
-        [
-            "link",
-            {
-                "rel": "stylesheet",
-                "href": "https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.6.0/katex.min.css"
-            }
         ]
     ]
 }
diff --git a/docs/.vitepress/draft/draft.md b/docs/.vitepress/draft/draft.md
diff --git a/docs/GLOSSARY.md b/docs/GLOSSARY.md
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
diff --git a/docs/ch01_environment.md → docs/chapters/ch01_environment.md b/docs/ch01_environment.md → docs/chapters/ch01_environment.md
diff --git a/docs/ch02_computation.md → docs/chapters/ch02_computation.md b/docs/ch02_computation.md → docs/chapters/ch02_computation.md
diff --git a/docs/ch03_procedure.md → docs/chapters/ch03_procedure.md b/docs/ch03_procedure.md → docs/chapters/ch03_procedure.md
diff --git a/docs/ch04_encoding.md → docs/chapters/ch04_encoding.md b/docs/ch04_encoding.md → docs/chapters/ch04_encoding.md
diff --git a/docs/ch05_sequence.md → docs/chapters/ch05_sequence.md b/docs/ch05_sequence.md → docs/chapters/ch05_sequence.md
@@ -103,7 +103,7 @@ content.length // 6
 
 就像这张图片描述的：
 
-![list](./res/images/cons-cells.png)
+![list](../res/images/cons-cells.png)
 
 这种结构被称为链接列表（也叫链表，Linked List）在上世纪五十年代就已经设计用于实际的程序。链表这种结构非常的灵活，可以很轻松的在任意位置添加或者删除数据。因为并不需要内存结构上的连续，所有的位序关系都是靠前一个元素和后一个元素之间的链接关系来确定，而添加或者删除数据只要改变一下这种链接关系就可以了。
 

diff --git a/docs/ch06_data.md → docs/chapters/ch06_data.md b/docs/ch06_data.md → docs/chapters/ch06_data.md
@@ -88,7 +88,7 @@ let arith = {
 
 这里我们要拿前面提到的一个例子来说事儿了。
 
-![list](./res/images/cons-cells.png)
+![list](../res/images/cons-cells.png)
 
 看这张图，去掉这个list的第一个节点，结果得到的还是一个list。同样地，在这个节点上面再加一个节点，得到的也依然还是一个list。
 

diff --git a/docs/ch07_state.md → docs/chapters/ch07_state.md b/docs/ch07_state.md → docs/chapters/ch07_state.md
diff --git a/docs/ch08_reference.md → docs/chapters/ch08_reference.md b/docs/ch08_reference.md → docs/chapters/ch08_reference.md
diff --git a/docs/ch09_closure.md → docs/chapters/ch09_closure.md b/docs/ch09_closure.md → docs/chapters/ch09_closure.md
diff --git a/docs/ch10_object.md → docs/chapters/ch10_object.md b/docs/ch10_object.md → docs/chapters/ch10_object.md
diff --git a/docs/ch11_concurrency.md → docs/chapters/ch11_concurrency.md b/docs/ch11_concurrency.md → docs/chapters/ch11_concurrency.md
diff --git a/docs/intro.md → docs/chapters/intro.md b/docs/intro.md → docs/chapters/intro.md
diff --git a/docs/concept/README.md b/docs/concept/README.md
diff --git a/docs/index.md b/docs/index.md
@@ -6,7 +6,7 @@ hero:
     tagline: "从零开始你的计算机编程之旅"
     actions:
         -   text: 开始阅读 →
-            link: /intro
+            link: /chapters/intro
             theme: brand
 # features:
 #   - icon: 🛠️

diff --git a/docs/reference/debug.md b/docs/reference/debug.md
diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md
@@ -0,0 +1,19 @@
+# 概念解释 Glossary
+
+## A
+
+- [安全](./safety-and-security.md)
+
+## C
+- [测试](./testing.md)
+
+## D
+- [Debug](./debug.md)
+
+## S
+- [Safety, Security](./safety-and-security.md)
+
+## T
+
+- [Testing](./testing.md)
+- [调试](./debug.md)
diff --git a/docs/concept/safety-and-security.md → docs/reference/safety-and-security.md b/docs/concept/safety-and-security.md → docs/reference/safety-and-security.md
diff --git a/docs/reference/testing.md b/docs/reference/testing.md
diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
     "dev": "vitepress dev docs"
   },
   "devDependencies": {
-    "markdown-it-katex": "^2.0.3",
+    "markdown-it-mathjax3": "^4.3.2",
     "vitepress": "^1.4.1"
   }
 }