reonokiy/blog
1
0
Fork 0
mirror of https://github.com/reonokiy/blog.nokiy.net.git synced 2025-06-15 11:12:54 +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-24 18:12:48 +00:00
parent ef2c0ee85f
commit 9e00ea9373
2 changed files with 55 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

56
src/content/posts/Markdown Style Guide-en.md
View file

@ -12,22 +12,42 @@ Here is a sample of some basic Markdown syntax that can be used when writing Mar
## Headings
The following HTML `<h1>`—`<h6>` elements represent six levels of section headings. `<h1>` is the highest section level while `<h6>` is the lowest.
To create a heading, add number signs `#` in front of a word or phrase. The number of number signs you use should correspond to the heading level.
### Syntax
```
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
```
### Output
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
## Paragraph
To create paragraphs, use a blank line to separate one or more lines of text.
### Syntax
```
Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.
Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.
```
### Output
Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.
Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.
@ -37,29 +57,33 @@ Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sap
### Syntax
```markdown
![Image Description](./full/or/relative/path/of/image)
![Image Description](./full/or/relative/path/of/image.webp)
![Image Description](https://example.com/image.webp)
```
### Output
![Image Description](/image-placeholder)
![Image Description](/image-placeholder)
## Blockquotes
The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a `footer` or `cite` element, and optionally with in-line changes such as annotations and abbreviations.
To create a blockquote, add a > in front of a paragraph. Blockquotes can contain multiple paragraphs.
### Blockquote without attribution
#### Syntax
```markdown
> Tiam, ad mint andaepu dandae nostion secatur sequo quae.<br>
> Tiam, ad mint andaepu dandae nostion secatur sequo quae.
>
> **Note** that you can use _Markdown syntax_ within a blockquote.
```
#### Output
> Tiam, ad mint andaepu dandae nostion secatur sequo quae.<br>
> Tiam, ad mint andaepu dandae nostion secatur sequo quae.
>
> **Note** that you can use _Markdown syntax_ within a blockquote.
### Blockquote with attribution
@ -67,25 +91,30 @@ The blockquote element represents content that is quoted from another source, op
#### Syntax
```markdown
> Don't communicate by sharing memory, share memory by communicating.<br>
> Don't communicate by sharing memory, share memory by communicating.
>
> — <cite>Rob Pike[^1]</cite>
```
#### Output
> Don't communicate by sharing memory, share memory by communicating.<br>
> Don't communicate by sharing memory, share memory by communicating.
>
> — <cite>Rob Pike[^1]</cite>
[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015.
## Tables
To add a table, use three or more hyphens `---` to create each column’s header, and use pipes `|` to separate each column.
### Syntax
```markdown
| Italics | Bold | Code |
| --------- | -------- | ------ |
| _italics_ | **bold** | `code` |
| _italics_ | **bold** | `code` |
```
### Output
@ -93,10 +122,11 @@ The blockquote element represents content that is quoted from another source, op
| Italics | Bold | Code |
| --------- | -------- | ------ |
| _italics_ | **bold** | `code` |
| _italics_ | **bold** | `code` |
## Code Blocks
we can use 3 backticks ``` in new line and write snippet and close with 3 backticks on new line and to highlight language specific syntax, write one word of language name after first 3 backticks, for eg. html, javascript, css, markdown, typescript, txt, bash.
To create a code block, add three backticks ```` ``` ```` at the start and end of your code. You can indicate the programming language being used after the opening backticks to indicate how to color and style your code, for eg. html, javascript, css, markdown etc.
### Syntax

20
src/content/posts/Markdown Style Guide-zh.md
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 等，即可实现语法高亮。
### 语法