Skip to content

Commit 802048d

Browse files
authored
fix: 修复渲染 (#121)
* fix: correctly render formulas, emojis and strikethrough fix: broken reference docs: add emoji guide * chore: remove unnecessary files
1 parent 3cb7cce commit 802048d

File tree

5 files changed

+55
-15
lines changed

5 files changed

+55
-15
lines changed

docs/ch3/sec0/1-basic.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ Markdown 是一种轻量级标记语言,具有**语法简洁、易读易写**
88

99
## 1. 标题
1010

11-
使用 `#` 表示标题,`#` 的数量决定标题级别(从 1 级到 6 级)。合理设置标题层级,有助于提升文档结构清晰度,方便他人快速查找所需。
11+
使用 `#` 表示标题,`#` 的数量决定标题级别(从 1 级到 5 级)。合理设置标题层级,有助于提升文档结构清晰度,方便他人快速查找所需。
1212

1313
```md preview
1414
# 一级标题
1515
## 二级标题
1616
### 三级标题
1717
#### 四级标题
1818
##### 五级标题
19-
###### 六级标题
19+
内容
2020
```
2121

2222
## 2. 段落与换行
@@ -42,6 +42,12 @@ Markdown 是一种轻量级标记语言,具有**语法简洁、易读易写**
4242
- **加粗**:`**加粗**` 或 `__加粗__`
4343
- *斜体*:`*斜体*` 或 `_斜体_`
4444
- ~~删除线~~:`~~删除线~~`
45+
46+
或者以上方法的混用,如:
47+
48+
- ***加粗斜体***
49+
- ~~*斜体删除*~~
50+
4551
```
4652

4753
## 4. 列表
@@ -53,6 +59,8 @@ Markdown 是一种轻量级标记语言,具有**语法简洁、易读易写**
5359
- 项目 1
5460
- 项目 2
5561

62+
---
63+
5664
1. 第一项
5765
2. 第二项
5866
```
@@ -64,7 +72,7 @@ Markdown 是一种轻量级标记语言,具有**语法简洁、易读易写**
6472
- 可点击的图片:`[![描述](图片地址)](点击后打开的地址)`
6573

6674
```md preview
67-
[百度](https://www.baidu.com)
75+
[华科开放原子俱乐部](https://oss.hust.openatom.club)
6876
![Logo](https://oss.hust.openatom.club/assets/logo.png)
6977
[![Logo](https://oss.hust.openatom.club/assets/logo.png)](https://hust.openatom.club)
7078
```

docs/ch3/sec0/2-advanced.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,18 @@ Markdown 除了基本的文本格式化,还支持更高级的功能,如公
1111
Markdown 支持使用 LaTeX 语法书写数学公式,常见于支持 MathJax 或 KaTeX 的渲染器中。
1212

1313
**行内公式**:使用 `$...$` 包裹公式内容
14-
例如:`$E=mc^2$` 显示为 $E=mc^2$
14+
```md preview
15+
$E=mc^2$
16+
```
1517

1618
**块级公式**:使用 `$$...$$` 包裹公式内容
17-
例如:
1819

19-
```bash
20+
```md preview
2021
$$
2122
\int_{a}^{b} f(x)\,dx = F(b) - F(a)
2223
$$
2324
```
2425

25-
显示为:
26-
27-
<p align="center">
28-
<img src="https://latex2png.com/pngs/c838ec0ff6cf48f333a310ba72dba65c.png" alt="LaTeX 公式图片" width="200">
29-
</p>
30-
3126
## 2. HTML 标签与 CSS 样式
3227

3328
Markdown 支持直接嵌入原生 HTML 标签,以实现更复杂的排版和样式。例如:
@@ -119,7 +114,7 @@ Mermaid 提供了[在线的图标编辑器](https://www.mermaidchart.com/play)
119114

120115
### 勾选框
121116

122-
```markdown
117+
```md preview
123118
- [ ] 未勾选的项目
124119
- [x] 勾选的项目
125120
```
@@ -128,6 +123,14 @@ Mermaid 提供了[在线的图标编辑器](https://www.mermaidchart.com/play)
128123

129124
可以通过 `:CODE:` 来插入一个表情。其中,每个表情的`code`可通过[这个网页](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md)查询
130125

126+
通常来说,我们会在[commit message](../sec1/subsec2/6-commit-message.md)的初始位置插入一个表情符号,让用户和其他维护者能够一眼看出此次 commit 的性质,如:
127+
128+
```md preview
129+
:hammer: fix(api): fix handling logic
130+
131+
:broom: chore: cleanup build deps
132+
```
133+
131134
### 提及其他人(Github)
132135

133136
可以使用 `@username``@org/team` 提及 Github 的用户。被提及的用户会收到通知。

docs/ch3/sec2/4-other-commands.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ man 可以被称为 Linux 系统的百科全书。从命令使用到操作系统
6363
一般来说,我们无需指定章节号。但是对于某些可能存在于多个章节的条目(比如`printf`既是一个位于章节 1 的工具,也是一个位于章节 3 的 API 函数),要想跳到其他章节,这个编号就是必须的。此时,命令的结构为 `man [section] name`
6464

6565
!!! info
66-
对于绝大部分人类来说,man pages 的文档还是有些过于晦涩了。别担心!我们可以使用一个叫`tldr`的开源工具来阅读更加实用、通俗易懂的说明。关于这个工具的详情,请参考下一节的“[常用的开源工具](../sec3/1-useful-oss.md)”篇目。
66+
对于绝大部分人类来说,man pages 的文档还是有些过于晦涩了。别担心!我们可以使用一个叫`tldr`的开源工具来阅读更加实用、通俗易懂的说明。关于这个工具的详情,请参考下一节的“[常用的开源工具](../sec5/1-useful-oss.md)”篇目。
6767

6868
### 1. 任务管理器系列
6969

@@ -601,7 +601,7 @@ Windows 里,我们可以使用设备管理器(devmgmt.msc)、磁盘管理
601601
若想从终端中分离,可以同时按下`Ctrl+A+D`按键
602602
若想结束一个终端,可以执行`screen -XS <session-id> quit`
603603
!!! note
604-
screen 工具由于维护不佳,导致出现了[许多漏洞](https://security.opensuse.org/2025/05/12/screen-security-issues.html)。在可能的情况下,我们更加推荐使用 tmux。关于这个工具的详情,请参考下一节的“[常用的开源工具](../sec3/1-useful-oss.md)”篇目
604+
screen 工具由于维护不佳,导致出现了[许多漏洞](https://security.opensuse.org/2025/05/12/screen-security-issues.html)。在可能的情况下,我们更加推荐使用 tmux。关于这个工具的详情,请参考下一节的“[常用的开源工具](../sec5/1-useful-oss.md)”篇目
605605

606606
## 🧪 小练习
607607

docs/scripts/mathjax.js

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
window.MathJax = {
2+
tex: {
3+
inlineMath: [["\\(", "\\)"]],
4+
displayMath: [["\\[", "\\]"]],
5+
processEscapes: true,
6+
processEnvironments: true
7+
},
8+
options: {
9+
ignoreHtmlClass: ".*|",
10+
processHtmlClass: "arithmatex"
11+
}
12+
};
13+
14+
document$.subscribe(() => {
15+
MathJax.startup.output.clearCache()
16+
MathJax.typesetClear()
17+
MathJax.texReset()
18+
MathJax.typesetPromise()
19+
})

mkdocs.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,14 @@ markdown_extensions:
5252
- footnotes
5353
- markdown.extensions.def_list
5454
- md_in_html
55+
- pymdownx.arithmatex:
56+
generic: true
57+
- pymdownx.tilde
5558
- pymdownx.details
5659
- pymdownx.tabbed
5760
- pymdownx.extra
5861
- pymdownx.inlinehilite
62+
- attr_list
5963
- pymdownx.emoji:
6064
emoji_index: !!python/name:material.extensions.emoji.twemoji
6165
emoji_generator: !!python/name:material.extensions.emoji.to_svg
@@ -73,6 +77,8 @@ markdown_extensions:
7377
format: !!python/name:pymdownx.superfences.fence_code_format
7478
- toc:
7579
permalink: true
80+
- pymdownx.tasklist:
81+
custom_checkbox: true
7682

7783
extra:
7884
social:
@@ -141,3 +147,7 @@ nav:
141147
- 第四章 导览: ch4/index.md
142148
- 附录:
143149
- 关于本教程: ch99/abouts.md
150+
151+
extra_javascript:
152+
- scripts/mathjax.js
153+
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

0 commit comments

Comments
 (0)