mirror of https://github.com/YunYouJun/valaxy
docs: Chineseized markdown.md (#325)
This commit is contained in:
Horon_Lee
GitHub
parent
74acc88321
commit
962aa4c776
|
|
@ -18,36 +18,76 @@ end: false
|
|||
:::
|
||||
|
||||
## Emoji :tada:
|
||||
## Emoji 表情支持 :tada: {lang="zh-CN"}
|
||||
|
||||
::: en
|
||||
**Input**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输入**
|
||||
:::
|
||||
|
||||
```
|
||||
:tada: :100:
|
||||
```
|
||||
|
||||
::: en
|
||||
**Output**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输出**
|
||||
:::
|
||||
|
||||
:tada: :100:
|
||||
|
||||
::: en
|
||||
A [list of all emojis](https://github.com/markdown-it/markdown-it-emoji/blob/master/lib/data/full.mjs) is available.
|
||||
:::
|
||||
|
||||
## Table of Contents
|
||||
::: zh-CN
|
||||
这是一个我们所 [支持的 Emoji 列表](https://github.com/markdown-it/markdown-it-emoji/blob/master/lib/data/full.mjs) 。
|
||||
:::
|
||||
|
||||
## Table of Contents {lang="en"}
|
||||
## 目录 {lang="zh-CN"}
|
||||
|
||||
::: en
|
||||
**Input**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输入**
|
||||
:::
|
||||
|
||||
```
|
||||
[[toc]]
|
||||
```
|
||||
|
||||
::: en
|
||||
**Output**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输出**
|
||||
:::
|
||||
|
||||
[[toc]]
|
||||
|
||||
::: en
|
||||
Rendering of the TOC can be configured using the `markdown.toc` option.
|
||||
:::
|
||||
|
||||
## 代码行高亮
|
||||
::: zh-CN
|
||||
可以使用 `markdown.toc` 选项配置 TOC 的渲染。
|
||||
:::
|
||||
|
||||
## Line of Code Highlighting {lang="en"}
|
||||
|
||||
## 代码行高亮 {lang="zh-CN"}
|
||||
|
||||
::: en
|
||||
**Input**
|
||||
:::
|
||||
|
||||
````
|
||||
```js{4}
|
||||
|
|
@ -61,7 +101,13 @@ export default {
|
|||
```
|
||||
````
|
||||
|
||||
::: en
|
||||
**Output**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输出**
|
||||
:::
|
||||
|
||||
```js{4}
|
||||
export default {
|
||||
|
|
@ -73,7 +119,13 @@ export default {
|
|||
}
|
||||
```
|
||||
|
||||
::: en
|
||||
**Input**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输入**
|
||||
:::
|
||||
|
||||
````md
|
||||
```ts {1}
|
||||
|
|
@ -95,7 +147,13 @@ const line4 = 'This is line 4'
|
|||
```
|
||||
````
|
||||
|
||||
::: en
|
||||
**Output**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输出**
|
||||
:::
|
||||
|
||||
```ts {1}
|
||||
// line-numbers is disabled by default
|
||||
|
|
@ -115,11 +173,32 @@ const line3 = 'This is line 3'
|
|||
const line4 = 'This is line 4'
|
||||
````
|
||||
|
||||
## Colored Diffs in Code Blocks
|
||||
## Colored Diffs in Code Blocks {lang="en"}
|
||||
## 代码块的增减色块标识 {lang="zh-CN"}
|
||||
|
||||
::: en
|
||||
Adding the `// [!code --]` or `// [!code ++]` comments on a line will create a diff of that line, while keeping the colors of the codeblock.
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
在一行上添加 `// [!code --]` 或者 `// [!code ++]` 注释将创建该行代码的增减标识，同时保持代码块的颜色。
|
||||
:::
|
||||
|
||||
::: en
|
||||
**Input**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输入**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
请注意，在 `!code`后面只需要一个空格，这里有两个空格以防被渲染。
|
||||
:::
|
||||
|
||||
::: en
|
||||
Note that only one space is needed after `!code`, there are two spaces here in case it is rendered.
|
||||
:::
|
||||
|
||||
````
|
||||
```js
|
||||
|
|
@ -134,7 +213,13 @@ export default {
|
|||
```
|
||||
````
|
||||
|
||||
::: en
|
||||
**Output**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输出**
|
||||
:::
|
||||
|
||||
```js
|
||||
export default {
|
||||
|
|
@ -147,11 +232,33 @@ export default {
|
|||
}
|
||||
```
|
||||
|
||||
## Errors and Warnings in Code Blocks
|
||||
## Errors and Warnings in Code Blocks {lang="en"}
|
||||
|
||||
## 代码块中的错误和警告 {lang="zh-CN"}
|
||||
|
||||
::: en
|
||||
Adding the `// [!code warning]` or `// [!code error]` comments on a line will color it accordingly.
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
在一行代码后中添加 `// [!code warning]` 或者 `// [!code error]` 注释将会使改行代码呈现指定颜色块。
|
||||
:::
|
||||
|
||||
::: en
|
||||
**Input**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输入**
|
||||
:::
|
||||
|
||||
::: en
|
||||
Note that only one space is needed after `!code`, there are two spaces here in case it is rendered.
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
请注意，在 `!code`后面只需要一个空格，这里有两个空格以防被渲染。
|
||||
:::
|
||||
|
||||
````
|
||||
```js
|
||||
|
|
@ -166,7 +273,13 @@ export default {
|
|||
```
|
||||
````
|
||||
|
||||
::: en
|
||||
**Output**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输出**
|
||||
:::
|
||||
|
||||
```js
|
||||
export default {
|
||||
|
|
@ -179,36 +292,72 @@ export default {
|
|||
}
|
||||
```
|
||||
|
||||
## Import Code Snippets
|
||||
|
||||
## Import Code Snippets {lang="en"}
|
||||
## 导入代码片段 {lang="zh-CN"}
|
||||
::: en
|
||||
You can import code snippets from existing files via following syntax:
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
您可以通过以下语法从现有文件中导入代码片段：
|
||||
:::
|
||||
|
||||
```md
|
||||
<<< @/filepath
|
||||
```
|
||||
|
||||
::: en
|
||||
It also supports [line highlighting](#line-highlighting-in-code-blocks):
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
它还支持 [行高亮](#line-highlighting-in-code-blocks):
|
||||
:::
|
||||
|
||||
```md
|
||||
<<< @/filepath{highlightLines}
|
||||
```
|
||||
|
||||
::: en
|
||||
**Input**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输入**
|
||||
:::
|
||||
|
||||
```md
|
||||
<<< @/snippets/snippet.js{2}
|
||||
```
|
||||
|
||||
::: en
|
||||
**Code file**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**代码文件**
|
||||
:::
|
||||
|
||||
<<< @/snippets/snippet.js
|
||||
|
||||
::: en
|
||||
**Output**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输出**
|
||||
:::
|
||||
|
||||
<<< @/snippets/snippet.js
|
||||
|
||||
::: tip
|
||||
|
||||
::: en
|
||||
The value of `@` corresponds to the source root. By default it's the blog root, unless `srcDir` is configured. Alternatively, you can also import from relative paths:
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
`@` 的值与源根相对应。默认情况下是博客根目录，除非配置了 `srcDir` 。另外，你也可以从相对路径导入：
|
||||
:::
|
||||
|
||||
```md
|
||||
<<< ../snippets/snippet.js
|
||||
|
|
@ -216,23 +365,53 @@ The value of `@` corresponds to the source root. By default it's the blog root,
|
|||
|
||||
:::
|
||||
|
||||
::: en
|
||||
You can also use a [VS Code region](https://code.visualstudio.com/docs/editor/codebasics#_folding) to only include the corresponding part of the code file. You can provide a custom region name after a `#` following the filepath:
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
您也可以使用 [VS Code region](https://code.visualstudio.com/docs/editor/codebasics#_folding) 只包含代码文件的相应部分。您可以在文件路径后的 `#` 后提供自定义区域名称：
|
||||
:::
|
||||
|
||||
::: en
|
||||
**Input**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输入**
|
||||
:::
|
||||
|
||||
```md
|
||||
<<< @/snippets/snippet-with-region.js#snippet{1}
|
||||
```
|
||||
|
||||
::: en
|
||||
**Code file**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**代码文件**
|
||||
:::
|
||||
|
||||
<<< @/snippets/snippet-with-region.js
|
||||
|
||||
::: en
|
||||
**Output**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输出**
|
||||
:::
|
||||
|
||||
<<< @/snippets/snippet-with-region.js#snippet{1}
|
||||
|
||||
::: en
|
||||
You can also specify the language inside the braces (`{}`) like this:
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
您也可以像这样在大括号（`{}`）内指定语言：
|
||||
:::
|
||||
|
||||
```md
|
||||
<<< @/snippets/snippet.cs{c#}
|
||||
|
|
@ -246,13 +425,29 @@ You can also specify the language inside the braces (`{}`) like this:
|
|||
<<< @/snippets/snippet.cs{1,2,4-6 c#:line-numbers}
|
||||
```
|
||||
|
||||
::: en
|
||||
This is helpful if source language cannot be inferred from your file extension.
|
||||
|
||||
::: zh-CN
|
||||
如果无法从文件扩展名推断源语言，这将很有帮助。
|
||||
:::
|
||||
## Code Groups
|
||||
|
||||
::: en
|
||||
You can group multiple code blocks like this:
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
您可以像这样对多个代码块进行分组：
|
||||
:::
|
||||
|
||||
::: en
|
||||
**Input**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输入**
|
||||
:::
|
||||
|
||||
````md
|
||||
::: code-group
|
||||
|
|
@ -281,7 +476,13 @@ export default config
|
|||
:::
|
||||
````
|
||||
|
||||
::: en
|
||||
**Output**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输出**
|
||||
:::
|
||||
|
||||
::: code-group
|
||||
|
||||
|
|
@ -308,9 +509,21 @@ export default config
|
|||
|
||||
:::
|
||||
|
||||
::: en
|
||||
You can also [import snippets](#import-code-snippets) in code groups:
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
你也可以在代码组中 [导入代码片段](#import-code-snippets) 。
|
||||
:::
|
||||
|
||||
::: en
|
||||
**Input**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输入**
|
||||
:::
|
||||
|
||||
```md
|
||||
::: code-group
|
||||
|
|
@ -326,7 +539,13 @@ You can also [import snippets](#import-code-snippets) in code groups:
|
|||
:::
|
||||
```
|
||||
|
||||
::: en
|
||||
**Output**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输出**
|
||||
:::
|
||||
|
||||
::: code-group
|
||||
|
||||
|
|
@ -381,21 +600,45 @@ details
|
|||
|
||||
:::
|
||||
|
||||
## KaTeX
|
||||
## KaTeX {lang="en"}
|
||||
|
||||
## KaTeX语法支持 {lang="zh-CN"}
|
||||
|
||||
::: tip
|
||||
|
||||
::: en
|
||||
More information about $\KaTeX$ examples can be found [here](/examples/katex).
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
有关更多KaTeX语法的信息可以在 [此处](/examples/katex) 找到。
|
||||
:::
|
||||
|
||||
:::
|
||||
|
||||
::: en
|
||||
**Input**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输入**
|
||||
:::
|
||||
|
||||
```md
|
||||
|
||||
::: en
|
||||
When $a \ne 0$, there are two solutions to $(ax^2 + bx + c = 0)$ and they are
|
||||
$$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$
|
||||
|
||||
**Maxwell's equations:**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
当 $a \ne 0$时，$(ax^2 + bx + c = 0)$ 有两个解，他们是
|
||||
$$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$
|
||||
|
||||
**麦克斯韦方程：**
|
||||
:::
|
||||
|
||||
| equation | description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
|
|
@ -404,12 +647,27 @@ $$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$
|
|||
| $\nabla \times \vec{\mathbf{B}} -\, \frac1c\, \frac{\partial\vec{\mathbf{E}}}{\partial t} = \frac{4\pi}{c}\vec{\mathbf{j}} \nabla \cdot \vec{\mathbf{E}} = 4 \pi \rho$ | _wha?_ |
|
||||
```
|
||||
|
||||
::: en
|
||||
**Output**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输出**
|
||||
:::
|
||||
|
||||
::: en
|
||||
When $a \ne 0$, there are two solutions to $(ax^2 + bx + c = 0)$ and they are
|
||||
$$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$
|
||||
|
||||
**Maxwell's equations:**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
当 $a \ne 0$时，$(ax^2 + bx + c = 0)$ 有两个解，他们是
|
||||
$$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$
|
||||
|
||||
**麦克斯韦方程：**
|
||||
:::
|
||||
|
||||
| equation | description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
|
|
@ -417,10 +675,18 @@ $$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$
|
|||
| $\nabla \times \vec{\mathbf{E}}\, +\, \frac1c\, \frac{\partial\vec{\mathbf{B}}}{\partial t} = \vec{\mathbf{0}}$ | curl of $\vec{\mathbf{E}}$ is proportional to the rate of change of $\vec{\mathbf{B}}$ |
|
||||
| $\nabla \times \vec{\mathbf{B}} -\, \frac1c\, \frac{\partial\vec{\mathbf{E}}}{\partial t} = \frac{4\pi}{c}\vec{\mathbf{j}} \nabla \cdot \vec{\mathbf{E}} = 4 \pi \rho$ | _wha?_ |
|
||||
|
||||
### Custom KaTeX Options
|
||||
### Custom KaTeX Options {lang="en"}
|
||||
|
||||
### 自定义 KaTeX 选项 {lang="zh-CN"}
|
||||
|
||||
::: en
|
||||
> [KaTeX options](https://katex.org/docs/options.html)
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
> [KaTeX选项](https://katex.org/docs/options.html)
|
||||
:::
|
||||
|
||||
```ts
|
||||
// valaxy.config.ts
|
||||
export default defineValaxyConfig({
|
||||
|
|
@ -436,13 +702,20 @@ export default defineValaxyConfig({
|
|||
})
|
||||
```
|
||||
|
||||
## Markdown File Inclusion<!-- -->
|
||||
## Markdown File Inclusion<!-- --> {lang="en"}
|
||||
|
||||
## 包含 MarkDown 文件<!-- --> {lang="zh-CN"}
|
||||
::: tip
|
||||
You can also prefix the markdown path with `@`, it will act as the source root. By default, it's the Valaxy project root.
|
||||
:::
|
||||
|
||||
::: en
|
||||
**Input**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输入**
|
||||
:::
|
||||
|
||||
```md
|
||||
## Docs
|
||||
|
|
@ -450,8 +723,13 @@ You can also prefix the markdown path with `@`, it will act as the source root.
|
|||
<!--@include: @/TEST.md-->
|
||||
<!--@include: ./parts/basics.md-->
|
||||
```
|
||||
|
||||
::: en
|
||||
**Part file**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**部分文件**
|
||||
:::
|
||||
|
||||
::: code-group
|
||||
|
||||
|
|
@ -469,7 +747,13 @@ I'm a TEST.
|
|||
|
||||
:::
|
||||
|
||||
::: en
|
||||
**Equivalent code**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**等效代码**
|
||||
:::
|
||||
|
||||
```md
|
||||
## Docs
|
||||
|
|
@ -482,9 +766,21 @@ Some getting started stuff.
|
|||
Can be created using `.foorc.json`.
|
||||
```
|
||||
|
||||
::: en
|
||||
It also supports selecting a line range:
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
它还支持选择行范围：
|
||||
:::
|
||||
|
||||
::: en
|
||||
**Input**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**输入**
|
||||
:::
|
||||
|
||||
```md
|
||||
## Docs
|
||||
|
|
@ -493,7 +789,13 @@ It also supports selecting a line range:
|
|||
<!--@include: ./parts/basics.md{3,}-->
|
||||
```
|
||||
|
||||
::: en
|
||||
**Part file**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**部分文件**
|
||||
:::
|
||||
|
||||
::: code-group
|
||||
|
||||
|
|
@ -511,7 +813,13 @@ I'm a TEST.
|
|||
|
||||
:::
|
||||
|
||||
::: en
|
||||
**Equivalent code**
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
**等效代码**
|
||||
:::
|
||||
|
||||
```md
|
||||
## Docs
|
||||
|
|
@ -522,17 +830,43 @@ I'm a TEST.
|
|||
Can be created using `.foorc.json`.
|
||||
```
|
||||
|
||||
::: en
|
||||
The format of the selected line range can be: `{3,}`, `{,10}`, `{1,10}`
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
所选行范围的格式可以是： `{3,}`, `{,10}`, `{1,10}`
|
||||
:::
|
||||
|
||||
::: warning
|
||||
|
||||
::: en
|
||||
Note that this does not throw errors if your file is not present. Hence, when using this feature make sure that the contents are being rendered as expected.
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
请注意，如果文件不存在，该功能不会出错。因此，在使用此功能时，请确保内容已按预期渲染。
|
||||
:::
|
||||
|
||||
:::
|
||||
|
||||
## UnoCSS
|
||||
|
||||
::: en
|
||||
We integrated [UnoCSS](https://unocss.dev), so you can use it in your markdown file.
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
我们集成了 [UnoCSS](https://unocss.dev)，因此您可以在标记符文件中使用它。
|
||||
:::
|
||||
|
||||
::: en
|
||||
Freedom to control your layout!
|
||||
:::
|
||||
|
||||
::: zh-CN
|
||||
自由控制你的布局！
|
||||
:::
|
||||
|
||||
> 更多配置见 [UnoCSS | 扩展配置](/guide/config/extend#unocss-presets)。
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue