基础知识
Markdown 语法
标准 Markdown 中的文本、标题和样式。
标题
使用标题来引入主要章节。它们能组织你的文档结构,并帮助用户浏览内容。
## 标题
副标题
使用副标题进一步划分章节。它们能创建更详细的内容层级,提升可读性。
### 副标题
每个标题和副标题都会自动创建锚点,并出现在目录中。
文本格式化
Docus 支持大多数 Markdown 格式化选项。
| 样式 | 使用方式 | 效果 |
|---|---|---|
| 粗体 | **bold** | 粗体 |
| 斜体 | *italic* | 斜体 |
| 删除线 | ~~strike~~ |
组合多种格式以实现更丰富的文本样式和视觉强调。
| 样式 | 使用方式 | 效果 |
|---|---|---|
| 粗体 + 斜体 | **_bold italic_** | 粗斜体 |
| 粗体 + 删除线 | ~~**bold**~~ | |
| 斜体 + 删除线 | ~~*italic*~~ |
链接
链接用于连接文档的不同部分以及外部资源,对用户导航和提供参考至关重要。
要创建链接,请将链接文本用方括号和圆括号包裹:[]()。
[Nuxt UI](https://ui.nuxt.com/getting-started/installation/nuxt)
内部链接
在文档内部进行链接时,请使用根目录相对路径,例如 /getting-started/installation。
[安装指南](/en/getting-started/installation)
列表
以结构化且易读的格式组织相关项目。Markdown 支持无序列表、有序列表和嵌套列表,以满足各种内容需求。
无序列表
当项目没有特定顺序时,请使用无序列表。每项开头使用 - 符号。
- 我是一个列表项。
- 我是另一个列表项。
- 我是最后一个列表项。
- 我是一个列表项。
- 我是另一个列表项。
- 我是最后一个列表项。
有序列表
当项目顺序很重要时(例如流程步骤),请使用有序列表。每项开头使用数字。
- 我是一个列表项。
- 我是另一个列表项。
- 我是最后一个列表项。
1. 我是一个列表项。
2. 我是另一个列表项。
3. 我是最后一个列表项。
嵌套列表
通过子项目创建层级结构的列表,适用于复杂内容。子项目需缩进四个空格以实现嵌套。
- 我是一个列表项。
- 我是一个嵌套的列表项。
- 我是另一个嵌套的列表项。
- 我是另一个列表项。
- 我是一个列表项。
- 我是一个嵌套的列表项。
- 我是另一个嵌套的列表项。
- 我是另一个列表项。
表格
以清晰的行列形式呈现结构化数据。表格非常适合用于数据对比或属性罗列。
| 属性 | 默认值 | 类型 |
|---|---|---|
name | string | |
size | md | string |
color | neutral | string |
| 属性 | 默认值 | 类型 |
| ------- | --------- | ------------------------ |
| `name` | | `string`{lang="ts-type"} |
| `size` | `md` | `string`{lang="ts-type"} |
| `color` | `neutral` | `string`{lang="ts-type"} |
引用块(Blockquotes)
突出显示重要引文、引用或强调文本。引用块在视觉上将引用内容与其他内容区分开来。
单行引用
单行引用最适合简短而有力的引文或引用,适合一行内展示。创建单行引用时,在段落前添加 >。适用于简短而有力的引文。
Nuxt UI 是一套 Vue 组件、组合函数和工具集,专注于结构与布局,旨在作为你应用的构建模块。
> Nuxt UI 是一套 Vue 组件、组合函数和工具集,专注于结构与布局,旨在作为你应用的构建模块。
多行引用
多行引用适用于较长的引文,或需要在同一引用中包含多个段落的情况。
Nuxt UI 是一套 Vue 组件、组合函数和工具集,专注于结构与布局,旨在作为你应用的构建模块。
使用 Nuxt UI 创建美观、响应式且无障碍的 Vue 应用程序。
> Nuxt UI 是一套 Vue 组件、组合函数和工具集,专注于结构与布局,旨在作为你应用的构建模块。
>
> 使用 Nuxt UI 创建美观、响应式且无障碍的 Vue 应用程序。