切换深色模式
页面编写示例
这一页展示手册常用的内容样式。以后添加教程时,可以按相同方式组织内容。
标题与章节
每一页使用一个一级标题,正文用二级、三级标题划分。右侧「本页目录」会根据章节自动生成。
md
# 页面标题
简短介绍这篇文章能解决什么问题。
## 第一步
写下具体操作。
### 补充说明
只补充当前步骤需要的信息。提示框
小提示
把有帮助的小技巧放在这里,让读者更快完成操作。
说明
把适用范围或背景信息放在这里。
操作前确认
需要读者留意的前置条件可以使用这种样式。
表格与代码块
| 内容 | 示例 |
|---|---|
| 标题 | 使用清晰、简短的名称 |
| 图片 | 添加能够解释画面的替代文本 |
| 链接 | 写出链接目的,方便读者判断 |
例如,下面是一段文档配置示例:
ts
export default {
title: '星缘 Wiki',
lang: 'zh-CN',
themeConfig: {
search: { provider: 'local' }
}
}代码块右上角可以复制代码。
折叠说明
点击展开补充内容
把不影响主流程的背景、解释或排查细节收进这里,让文章主体保持清晰。