Markdown 语法指南
这页只整理幻梦Bot文档里 最常用、最值得优先采用 的 Markdown 写法。目标不是把所有语法都列一遍,而是帮助你更快写出和站内风格一致的页面。
信息
如果你需要使用彩色文本、标签页、图片属性、表格增强等扩展写法,请继续阅读 自有语法指南。
标题
标题层级推荐保持简洁。
#用于页面标题。##用于主章节。###用于子章节。- 一般不建议写到
####以后。
# 贡献指南
## 中文排版建议
### 中文与英文之间留空格段落与换行
普通说明文字直接写成自然段即可。一个段落只讲一个重点,读起来会更轻松。
这是一段普通说明。
这是下一段说明。提示
虽然本站开启了更宽松的换行渲染,但写文档时仍然更推荐用“空一行”来分段,而不是把很多句子强行挤在同一段里。
现在站内还会保留“额外空行”的层级:
第一段。
第二段。上面这种写法在渲染时,不会再被压成普通的“只空一行”。空得更多,页面上就会确实更空一些。
列表
当内容本身就是并列项、步骤或检查项时,优先使用列表。
无序列表
无序列表已经额外收紧了正文场景的上下间距,下面这些写法现在都会更自然:
说明文字
- 列表项
- 列表项第一行
第二行
- 第一项
- 第二项- 适合罗列要点
- 适合列出注意事项
- 适合列出同级信息有序列表
有序列表编号也按自然宽度显示,不会再把 9. 人为补一个左侧空位去和 10. 对齐。
1. 先说明入口。
2. 再说明操作步骤。
3. 最后补充结果或注意事项。链接
站内和站外链接都直接使用标准 Markdown 语法即可。
[贡献指南](/about/contribution/)
[VitePress 官网](https://vitepress.dev/)推荐在链接前后与正文留出空格,这样可读性更好。
图片
图片是站内文档非常常见的一部分,尤其是功能教程和玩法说明页。
最基础的写法如下:
如果需要控制位置和尺寸,推荐配合本站已启用的属性语法使用:
{.hm-center-img width="400"}更多关于图片类名和属性写法的说明,请看 自有语法指南。
表格
表格适合展示固定字段、对比项、奖励数值、规则差异等内容。
| 难度 | 奖励 | 惩罚 |
| :-- | :-- | :-- |
| 简单 | 较低 | 较低 |
| 困难 | 较高 | 较高 |如果表格列很多、内容很长,推荐再配合本站的表格增强写法。详细说明见 自有语法指南。
代码块
代码块适合展示:
- 指令
- 配置片段
- Markdown 示例
- 需要原样保留格式的内容
```md
## 标题
- 列表项
```如果只是像 /娱乐功能设置 这种很短的内容,优先用行内代码,不必单独开代码块。
引用
引用适合放补充说明、备注、示例说明等较短内容。
> 这是一段补充说明。如果内容更重要、更需要视觉强调,优先使用提示块而不是普通引用。
分隔线
当页面开头需要把标题和正文轻微分开时,可以使用分隔线。
---站内有些旧页面也会使用 ***,但新写内容更推荐统一使用 ---。
一个推荐示例
下面这段结构很适合写说明类页面:
# 页面标题
---
一句话说明这页要讲什么。
## 基本写法
先解释,再给最小示例。
## 常见场景
- 场景 1
- 场景 2
## 注意事项
> 这里可以补一条简短提醒。什么时候该换成自有语法
当你遇到下面这些需求时,就不要只停留在标准 Markdown 了:
- 需要彩色强调重点文字。
- 需要给图片加类名、尺寸或布局。
- 需要写标签页内容。
- 需要增强表格宽度和响应式表现。
- 需要在 Markdown 中适度混排 HTML。
这时请继续参考 自有语法指南。