基础
Markdown 语法
标准 Markdown 中的文本、标题和样式。
标题
使用标题介绍主要章节。它们会组织你的文档结构,并帮助用户浏览内容。
## Titles
副标题
使用副标题进一步划分章节。它们会创建更细致的内容层级,提升可读性。
### Subtitles
每个标题和副标题都会创建锚点,并自动显示在目录中。
文本格式
Docus 支持大多数 Markdown 格式选项。
| 样式 | 用法 | 结果 |
|---|---|---|
| 粗体 | **bold** | Bold |
| 斜体 | *italic* | Italic |
| 删除线 | ~~strike~~ |
组合格式可以创建更丰富的文本样式和视觉强调。
| 样式 | 用法 | 结果 |
|---|---|---|
| 粗斜体 | **_bold italic_** | Bold Italic |
| 粗体删除线 | ~~**bold**~~ | |
| 斜体删除线 | ~~*italic*~~ |
链接
链接用于连接文档的不同部分和外部资源,是用户导航和引用资料的基础。要创建链接,请把链接文本包在方括号中,并在后面加上 URL:[]()。
[Nuxt UI](https://ui.nuxt.com/getting-started/installation/nuxt)
内部链接
在文档内部链接时,使用类似 /getting-started/installation 的根相对路径。
[Installation](/zh-cn/getting-started/installation)
列表
用结构化、易读的形式组织相关条目。Markdown 支持无序列表、有序列表和嵌套列表。
无序列表
无序列表适用于没有特定顺序的条目。每个条目以 - 开头。
- 我是一个列表项。
- 我是另一个列表项。
- 我是最后一个列表项。
- I'm a list item.
- I'm another list item.
- I'm the last list item.
有序列表
有序列表适用于顺序重要的内容,例如流程步骤。每个条目以数字开头。
- 我是一个列表项。
- 我是另一个列表项。
- 我是最后一个列表项。
1. I'm a list item.
2. I'm another list item.
3. I'm the last list item.
嵌套列表
使用子项创建层级列表,用于表达复杂结构。子项缩进四个空格。
- 我是一个列表项。
- 我是一个嵌套列表项。
- 我是另一个嵌套列表项。
- 我是另一个列表项。
- I'm a list item.
- I'm a nested list item.
- I'm another nested list item.
- I'm another list item.
表格
表格用于清晰地以行和列呈现结构化数据,适合比较数据或列出属性。
| Prop | Default | Type |
|---|---|---|
name | string | |
size | md | string |
color | neutral | string |
| Prop | Default | Type |
|---------|-----------|--------------------------|
| `name` | | `string`{lang="ts-type"} |
| `size` | `md` | `string`{lang="ts-type"} |
| `color` | `neutral` | `string`{lang="ts-type"} |
引用
引用用于突出重要引文、引用来源或强调文本。它会在视觉上区分被引用的内容。
单行
单行引用适合短而有力的引文或引用。要创建单行引用,请在段落前添加 >。
Nuxt UI 是一组 Vue 组件、composables 和工具,侧重结构与布局,并设计为应用构建模块。
> Nuxt UI is a collection of Vue components, composables and utils, oriented on structure and layout and designed to be used as building blocks for your app.
多行
多行引用适合较长引用,或需要在一个引用中包含多个段落的情况。
Nuxt UI 是一组 Vue 组件、composables 和工具,侧重结构与布局,并设计为应用构建模块。
使用 Nuxt UI 创建漂亮、响应式且可访问的 Vue 应用。
> Nuxt UI is a collection of Vue components, composables and utils, oriented on structure and layout and designed to be used as building blocks for your app.
>
> Create beautiful, responsive, and accessible Vue applications with Nuxt UI.