Skip to content

Commit

Permalink
spec/writing: Definition list
Browse files Browse the repository at this point in the history
  • Loading branch information
taoky committed Oct 19, 2024
1 parent 628bad2 commit 6fb2358
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion docs/spec/writing.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Linux 201 使用 mkdocs + mkdocs-material 作为文档框架与主题,并且

### 为标题和小标题添加 ID {#heading-ids}

由于文章篇目较长,使用时会经常遇到需要链接到文章某一段的情况。受限于 MkDocs 自动生成 Anchor ID 的功能(只支持英文字符),纯中文的标题会导致生成 `_1`, `_2` 这样的 ID。一方面这样的 ID 看起来不直观,另一方面每当标题发生增减时这些 ID 都会变,因此请为每个**除了 h1 以外的标题**手动添加一个有意义的 ID(最开始的标题 H1 除外),方法如下:
由于文章篇目较长,使用时会经常遇到需要链接到文章某一段的情况。受限于 MkDocs 自动生成 Anchor ID 的功能(只支持英文字符),纯中文的标题会导致生成 `_1`, `_2` 这样的 ID。一方面这样的 ID 看起来不直观,另一方面每当标题发生增减时这些 ID 都会变,因此请为每个**除了 h1 以外的标题**手动添加一个有意义的 ID,方法如下:

```markdown
### 为标题和小标题添加 ID {#heading-ids}
Expand Down Expand Up @@ -126,6 +126,34 @@ Linux 201 使用 mkdocs + mkdocs-material 作为文档框架与主题,并且
[fstab(5)][fstab.5] 提供了……
```

### 定义列表 {#definition-list}

在写作时,我们可能会需要列出多个术语,同时给出它们的定义或者介绍,如果使用普通的有序或无序列表的话,给读者的观感可能过于紧凑。此时可以考虑使用定义列表格式,类似如下:

```markdown
定义一

: 本项经常出现在科大西区和中区的交界处:肥西路上。在晚上九点之后,有概率可以在路边发现本项。

需要注意的是,离开校门时请带好手机。

定义二

: 我编不下去了。
```

显示效果如下:

定义一

: 本项经常出现在科大西区和中区的交界处:肥西路上。在晚上九点之后,有概率可以在路边发现本项。

需要注意的是,离开校门时请带好手机。

定义二

: 我编不下去了。

## 内容要求 {#content}

### 编写原则 {#principle}
Expand Down

0 comments on commit 6fb2358

Please sign in to comment.