基础要点
Markdown 语法
标准 Markdown 中的文本、标题和样式。
标题
使用标题引入主要章节。它们结构化您的文档,帮助用户浏览内容。
## 标题
副标题
使用副标题进一步划分章节,创建更详细的内容层次以获得更好的可读性。
### 副标题
每个标题和副标题都会创建一个锚点,并自动显示在目录中。
文本格式化
TockDocs 支持大多数 Markdown 格式化选项。
| 样式 | 使用方法 | 结果 |
|---|---|---|
| 粗体 | **粗体** | 粗体 |
| 斜体 | *斜体* | 斜体 |
| 删除线 | ~~删除线~~ |
组合使用格式以获得更丰富的文本样式和视觉强调。
| 样式 | 使用方法 | 结果 |
|---|---|---|
| 粗斜体 | **_粗斜体_** | 粗斜体 |
| 粗体删除线 | ~~**粗体**~~ | |
| 斜体删除线 | ~~*斜体*~~ |
链接
链接连接文档的不同部分和外部资源,对用户导航和提供参考至关重要。
要创建链接,请将链接文本包裹在 []() 中。
[Nuxt UI](https://ui.nuxt.com/getting-started/installation/nuxt)
内部链接
要在文档内部链接,请使用根相对路径,如 /getting-started/installation。
[安装](/docs/manual/zh/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"} |
引用块
突出显示重要的引用、引文或强调文本。引用块在视觉上区分引用内容。
单行引用
单行引用块最适合简短的、有影响力的引用或引文,适合单行显示。要创建单行引用块,在段落前添加 >。
Nuxt UI 是一套 Vue 组件、组合式函数和工具的集合,以结构和布局为导向,旨在作为应用的构建模块。
> Nuxt UI 是一套 Vue 组件、组合式函数和工具的集合,以结构和布局为导向,旨在作为应用的构建模块。
多行引用
多行引用块适用于较长的引用,或当您需要在单个引用中包含多个段落时。
Nuxt UI 是一套 Vue 组件、组合式函数和工具的集合,以结构和布局为导向,旨在作为应用的构建模块。
使用 Nuxt UI 创建美观、响应式和可访问的 Vue 应用。
> Nuxt UI 是一套 Vue 组件、组合式函数和工具的集合,以结构和布局为导向,旨在作为应用的构建模块。
>
> 使用 Nuxt UI 创建美观、响应式和可访问的 Vue 应用。