reonokiy/blog
1
0
Fork 0
mirror of https://github.com/reonokiy/blog.nokiy.net.git synced 2025-06-15 19:22:52 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: update md style guide

Browse source
This commit is contained in:
radishzzz 2025-03-23 23:58:09 +00:00
parent 191950981e
commit 456aa2691e
1 changed files with 16 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

35
src/content/posts/Markdown Style Guide-zh.md
View file

@ -8,11 +8,11 @@ lang: zh
abbrlink: markdown-style-guide
---
本文是在 Retypeset 中编写 Markdown 内容时可用的一些基础语法示例。
以下是一些基本的 Markdown 语法示例，可以在 Retypeset 主题中使用。
## 标题
HTML 的 `<h1>` 至 `<h6>` 元素对应六级标题。`<h1>` 为最高级标题，`<h6>` 为最低级。
HTML 的 `<h1>` 至 `<h6>` 标签对应六个等级的标题。`<h1>` 为最高级标题，`<h6>` 为最低级。
# 一级标题
@ -34,6 +34,8 @@ HTML 的 `<h1>` 至 `<h6>` 元素对应六级标题。`<h1>` 为最高级标题
## 图片
使用相对路径 `../assets/image.jpg` 或绝对路径 `https://example.com/image.jpg` 引用图片。
### 语法
```markdown
@ -46,41 +48,37 @@ HTML 的 `<h1>` 至 `<h6>` 元素对应六级标题。`<h1>` 为最高级标题
## 块引用
块引用用于标注外部来源内容，内部可使用 Markdown 语法。若需添加来源注释，应通过 footer 或 cite 元素实现。
块引用用于标注外部来源内容，内部支持使用 Markdown 语法。若需添加来源注释，应使用 `footer` 或 `cite` 元素包裹。
### 无来源注释
#### 语法
```markdown
> 天地不仁，以万物为刍狗。
>
> **注意**：引用块内可使用 _Markdown 语法_。
> 天地不仁，以万物为刍狗。<br>
> **提示**：内可使用 _Markdown 语法_。
```
#### 效果
> 天地不仁，以万物为刍狗。
>
> **注意**：引用块内可使用 _Markdown 语法_。
> 天地不仁，以万物为刍狗。<br>
> **提示**：引用块内可使用 _Markdown 语法_。
### 带来源注释
### 有来源注释
#### 语法
```markdown
> 其实地上本没有路，走的人多了，也便成了路。
>
> 其实地上本没有路，走的人多了，也便成了路。<br>
> — <cite>《故乡》鲁迅[^1]</cite>
```
#### 效果
> 其实地上本没有路，走的人多了，也便成了路。
>
> 其实地上本没有路，走的人多了，也便成了路。<br>
> — <cite>《故乡》鲁迅[^1]</cite>
[^1]: 摘自鲁迅在 1921 年 1 月发表的[《故乡》](https://zh.wikisource.org/wiki/%E6%95%85%E9%84%89)。
[^1]: 摘自鲁迅，[《故乡》](https://zh.wikisource.org/wiki/%E6%95%85%E9%84%89)，发表于 1921 年 1 月。
## 表格
@ -100,9 +98,9 @@ HTML 的 `<h1>` 至 `<h6>` 元素对应六级标题。`<h1>` 为最高级标题
## 代码块
### 语法
在代码的开头和结尾处，添加三个反引号 ``` 来包裹代码，在开头的反引号后标注 html、javascript、css 等语言类型，以实现不同的语法高亮效果。
在代码的开头和结尾处，使用三个反引号 ``` 包裹代码，并在开头的反引号后标注 html、javascript、css 等语言类型，以实现不同的语法高亮效果。
### 语法
````markdown
```html
@ -222,7 +220,7 @@ X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>
书籍是人类进步的<del>楼梯</del>阶梯。
优秀的作者总是会仔细检查<u title="拼">拚</u>写错误。
优秀的作家总是会仔细检查<u title="拼写">拚写</u>问题。
按下 <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Delete</kbd> 以结束会话。
@ -239,4 +237,3 @@ X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>
<img src="https://image.radishzz.cc/picsmaller/03.webp">
<figcaption text-center="">Node 模块检查器 - 概览</figcaption>
</figure> -->
```