From ef2c0ee85f9d6cef5d3864f0d9ef8bf77d1cf8ca Mon Sep 17 00:00:00 2001 From: radishzzz Date: Mon, 24 Mar 2025 15:50:53 +0000 Subject: [PATCH] chore: update md style guide --- src/content/posts/Markdown Style Guide-zh.md | 66 ++++++++++++++------ 1 file changed, 48 insertions(+), 18 deletions(-) diff --git a/src/content/posts/Markdown Style Guide-zh.md b/src/content/posts/Markdown Style Guide-zh.md index 63ae191..791ae2c 100644 --- a/src/content/posts/Markdown Style Guide-zh.md +++ b/src/content/posts/Markdown Style Guide-zh.md @@ -8,78 +8,108 @@ lang: zh abbrlink: markdown-style-guide --- -以下是一些基本的 Markdown 语法示例,可以在 Retypeset 主题中使用。 +以下是一些基本的 Markdown 语法示例,以及在 Retypeset 主题的展示效果。 ## 标题 -HTML 的 `

` 至 `

` 标签对应六个等级的标题。`

` 为最高级标题,`

` 为最低级。 +在文本前添加井号 `#` 与空格,即可创建标题。井号数量对应标题等级。 + +### 语法 + +``` +# 一级标题 +## 二级标题 +### 三级标题 +#### 四级标题 +##### 五级标题 +###### 六级标题 +``` + +### 效果 # 一级标题 - ## 二级标题 - ### 三级标题 - #### 四级标题 - ##### 五级标题 - ###### 六级标题 ## 段落 +使用空白行分隔文本,即可创建段落。 + +### 语法 + +``` +孔乙己一到店,所有喝酒的人便都看着他笑,有的叫道:“孔乙己,你脸上又添上新伤疤了!”他不回答,对柜里说:“温两碗酒,要一碟茴香豆。”便排出九文大钱。他们又故意的高声嚷道:“你一定又偷了人家的东西了!”孔乙己睁大眼睛说:“你怎么这样凭空污人清白……”“什么清白?我前天亲眼见你偷了何家的书,吊着打。”孔乙己便涨红了脸,额上的青筋条条绽出,争辩道:“窃书不能算偷……窃书!……读书人的事,能算偷么?”接连便是难懂的话,什么“君子固穷”,什么“者乎”之类,引得众人都哄笑起来:店内外充满了快活的空气。 + +听人家背地里谈论,孔乙己原来也读过书,但终于没有进学,又不会营生;于是愈过愈穷,弄到将要讨饭了。 +``` + +### 效果 + 孔乙己一到店,所有喝酒的人便都看着他笑,有的叫道:“孔乙己,你脸上又添上新伤疤了!”他不回答,对柜里说:“温两碗酒,要一碟茴香豆。”便排出九文大钱。他们又故意的高声嚷道:“你一定又偷了人家的东西了!”孔乙己睁大眼睛说:“你怎么这样凭空污人清白……”“什么清白?我前天亲眼见你偷了何家的书,吊着打。”孔乙己便涨红了脸,额上的青筋条条绽出,争辩道:“窃书不能算偷……窃书!……读书人的事,能算偷么?”接连便是难懂的话,什么“君子固穷”,什么“者乎”之类,引得众人都哄笑起来:店内外充满了快活的空气。 听人家背地里谈论,孔乙己原来也读过书,但终于没有进学,又不会营生;于是愈过愈穷,弄到将要讨饭了。 ## 图片 +使用感叹号 `!` 方括号 `[]` 和圆括号 `()`,即可添加图片。这些符号都是英文半角符号,而非中文全角符号。 + ### 语法 ```markdown -![图片描述](./full/or/relative/path/of/image) +![图片描述](./relative/path/of/image.webp) +![图片描述](https://example.com/image.webp) ``` ### 效果 +![图片描述](/image-placeholder) ![图片描述](/image-placeholder) ## 块引用 -块引用标签表示从外部引用的内容,可以使用 `footer` 或 `cite` 标签标注内容来源,也可以在块引用中使用 ``、`` 等标签。 +在段落前添加 `>` 符号和空格,即可创建块引用。在段落之间的空白行添加 `>` 符号,即可包含多个段落。使用 `footer` 或 `cite` 标签包裹引用来源,即可添加脚注。 -### 未标注内容来源 +### 多个段落 #### 语法 ```markdown -> 天地不仁,以万物为刍狗。
+> 天地不仁,以万物为刍狗。 +> > **提示**:引用块内可使用 _Markdown 语法_。 ``` #### 效果 -> 天地不仁,以万物为刍狗。
+> 天地不仁,以万物为刍狗。 +> > **提示**:引用块内可使用 _Markdown 语法_。 -### 标注内容来源 +### 添加脚注 #### 语法 ```markdown -> 在我的后园,可以看见墙外有两株树,一株是枣树,还有一株也是枣树。
+> 在我的后园,可以看见墙外有两株树,一株是枣树,还有一株也是枣树。 +> > —— 《秋夜》[^1] ``` #### 效果 -> 在我的后园,可以看见墙外有两株树,一株是枣树,还有一株也是枣树。
+> 在我的后园,可以看见墙外有两株树,一株是枣树,还有一株也是枣树。 +> > —— 《秋夜》[^1] [^1]: [《秋夜》](https://zh.wikisource.org/wiki/%E7%A7%8B%E5%A4%9C_(%E9%AD%AF%E8%BF%85)) 是鲁迅散文诗集《野草》中的第一首散文诗,创作于1924年。 ## 表格 +使用三个或多个连字符 `---` 创建每列的标题,并使用管道符 `|` 分隔每列,即可创建表格。 + ### 语法 ```markdown @@ -96,7 +126,7 @@ HTML 的 `

` 至 `

` 标签对应六个等级的标题。`

` 为最高 ## 代码块 -在代码的开头和结尾处,添加三个反引号 ``` 来创建代码块。在开头的反引号后标注语言类型,例如 html、javascript、css、markdown 等,以实现语法高亮效果。 +在代码的顶部和底部添加三个反引号 ```` ``` ````,即可创建代码块。在顶部的反引号后标注语言类型,例如 html、javascript、css、markdown 等,即可实现语法高亮。 ### 语法 @@ -154,14 +184,14 @@ HTML 的 `

` 至 `

` 标签对应六个等级的标题。`

` 为最高 ```markdown - 列表项 -- 另一项 +- 图表项 - 更多项 ``` #### 效果 - 列表项 -- 另一项 +- 图表项 - 更多项 ### 嵌套列表