chore: update md style guide

This commit is contained in:
radishzzz 2025-03-24 18:12:48 +00:00
parent ef2c0ee85f
commit 9e00ea9373
2 changed files with 55 additions and 21 deletions

View file

@ -8,7 +8,7 @@ lang: zh
abbrlink: markdown-style-guide
---
以下是一些基本的 Markdown 语法示例,以及在 Retypeset 主题的展示效果。
以下是一些基本的 Markdown 语法示例,以及在 Retypeset 主题中的样式效果。
## 标题
@ -36,7 +36,7 @@ abbrlink: markdown-style-guide
## 段落
使用空行分隔文本,即可创建段落。
使用空行分隔文本,即可创建段落。
### 语法
@ -54,12 +54,12 @@ abbrlink: markdown-style-guide
## 图片
使用感叹号 `!` 方括号 `[]` 圆括号 `()`,即可添加图片。这些符号都是英文半角符号,而非中文全角符号。
使用感叹号 `!` 方括号 `[]` 圆括号 `()`,即可添加图片。这些符号都是英文半角符号,而非中文全角符号。
### 语法
```markdown
![图片描述](./relative/path/of/image.webp)
![图片描述](./full/or/relative/path/of/image.webp)
![图片描述](https://example.com/image.webp)
```
@ -70,7 +70,7 @@ abbrlink: markdown-style-guide
## 块引用
在段落前添加 `>` 符号和空格,即可创建块引用。在段落间的空行添加 `>` 符号,即可包含多个段落。使用 `footer``cite` 标签包裹引用来源,即可添加脚注。
在段落前添加 `>` 符号和空格,即可创建块引用。在段落间的空行添加 `>` 符号,即可包含多个段落。若需标注引用来源,可使用 `<cite>``<footer>` 标签添加文献来源,同时可通过 `[^1]``[^note]` 格式插入脚注。
### 多个段落
@ -88,7 +88,7 @@ abbrlink: markdown-style-guide
>
> **提示**:引用块内可使用 _Markdown 语法_
### 添加脚注
### 标注引用来源
#### 语法
@ -96,6 +96,8 @@ abbrlink: markdown-style-guide
> 在我的后园,可以看见墙外有两株树,一株是枣树,还有一株也是枣树。
>
> —— <cite>《秋夜》[^1]</cite>
[^1]: [《秋夜》](https://zh.wikisource.org/wiki/%E7%A7%8B%E5%A4%9C_(%E9%AD%AF%E8%BF%85)) 是鲁迅散文诗集《野草》中的第一首散文诗创作于1924年。
```
#### 效果
@ -108,7 +110,7 @@ abbrlink: markdown-style-guide
## 表格
使用三个或多个连字符 `---` 创建每列的标题,并使用管道符 `|` 分隔每列,即可创建表格。
使用三个或多个连字符 `---` 分隔标题,并使用管道符 `|` 分隔每列,即可创建表格。
### 语法
@ -116,6 +118,7 @@ abbrlink: markdown-style-guide
| 斜体 | 粗体 | 代码 |
| ------ | -------- | ------ |
| _斜体_ | **粗体** | `代码` |
| _斜体_ | **粗体** | `代码` |
```
### 效果
@ -123,10 +126,11 @@ abbrlink: markdown-style-guide
| 斜体 | 粗体 | 代码 |
| ------ | -------- | ------ |
| _斜体_ | **粗体** | `代码` |
| _斜体_ | **粗体** | `代码` |
## 代码块
在代码的顶部底部添加三个反引号 ```` ``` ````,即可创建代码块。在顶部的反引号后标注语言类型,例如 html、javascript、css、markdown 等,即可实现语法高亮。
在代码的顶部底部添加三个反引号 ```` ``` ````,即可创建代码块。在顶部的反引号后标注语言类型,例如 html、javascript、css、markdown 等,即可实现语法高亮。
### 语法