本站特有的 Markdown 语法
本页是投稿写作的语法速查:上半部分是通用 Markdown,下半部分是本站专属扩展。每个语法都同时给出写法(代码块内)与渲染效果。
想系统学习 Markdown,看基础语法(CommonMark 标准写法)与常见扩展语法(表格、脚注、公式等);只想一页查完,看语法速查表;还没挑好编辑器,看编辑软件对比。更偏实现细节的说明(参数表、接线方式)见站点功能说明。
标题
正文从 ## 开始用(# 一级标题由系统自动生成,正文不要再写);## 与 ### 会进入右侧目录。
## 二级标题(进目录)
### 三级标题(进目录)文字强调
| 语法 | 效果 | 用途 |
|---|---|---|
**加粗** | 加粗 | 强调。与马克笔共用同一条底部色带,只差字重 |
*斜体* | 斜体 | 书名、术语、外语词 |
~~删除线~~ | 过时信息 | |
`行内代码` | 行内代码 | 文件名、命令、按键 |
==马克笔== | 马克笔 | 最高级重点:考试重点、必背内容。色带与加粗同色,另带描线动画 |
加粗与马克笔是同一套视觉:加粗=粗体+色带,马克笔=色带(带自左向右的描线动画)不加粗,组合 ==**文字**== 只画一层色带、外观与加粗等同。马克笔是本站扩展,末尾写 {.配色} 可换颜色,内置三种:tip(提示·绿)/ caution(注意·黄)/ warning(警告·红):
==必背=={.tip} 与 ==易错点=={.warning}必背 与 易错点
组合写法要马克笔在外
==**文字**== 正常渲染;反过来写 **==文字**== 时,** 会退化成字面文本显示出来(markdown-it 的定界符配对不跨越容器边界)。两种写法视觉相同,统一用前者。
色带的颜色与厚度由主题包的 --wiki-emphasis-band 与 --wiki-emphasis-band-height 两个变量统一控制(深浅色各一档),三处写法同步生效,不需要逐篇设置。
行内注释与隐秘文本
行内注释
{^内容}:渲染成※小气泡,悬停/点按显示,适合名词解释(^ 后不要紧跟数字,避免误伤数学上标):示例:南开大学※简称「南开」,位于天津市创建于 1919 年。
隐秘文本
!!内容!!:黑幕遮住、悬停显示,适合防剧透卖关子;{.click}改为点击开合,{.blur}改为模糊:示例:你知道吗, 鲁迅 曾说过:" 我没说过这句话! "。
列表
- 无序列表项
- 另一项
- 缩进两格是子项
1. 有序列表项
2. 数字自动连续- 无序列表项
- 另一项
- 缩进两格是子项
- 有序列表项
- 数字自动连续
任务列表(勾选框仅作展示,不可交互):
- [x] 已完成
- [ ] 待完成引用与分割线
> 一段引用文字,适合写补充说明或原文摘录。
---一段引用文字,适合写补充说明或原文摘录。
链接与图片
[站内链接](/pages/Contributing/)
[外部链接](https://example.com/)
- 站内链接用文章的
permalink;图片放docs/public/img/对应目录,路径以/img/开头 - 图片的描述文字会作为点击放大后的题注,请认真填写
- 本地图片构建期自动注入宽高防止页面跳动;点击任意正文图片可全屏预览、缩放、左右切换
代码块
三个反引号开头,标注语言获得高亮;语言名后写 title="文件名" 可加标题栏(本站扩展):
```ts title="config.mts"
export default {}
```export default {}表格
| 功能 | 支持度 |
| ------ | :----: |
| 语法一 | ✅ |--- 与 :---: 控制对齐方式(左/中/右)。
| 功能 | 支持度 |
|---|---|
| 语法一 | ✅ |
提示容器
VitePress 内置容器,适合写注意事项(容器标记与内容之间要空一行):
::: tip 小技巧
这里是提示内容。
:::小技巧
这里是提示内容。
tip(绿)/ info(灰)/ note(灰)/ warning(橙)/ danger(红)/ caution / important 均可用。
步骤条与时间线
本站扩展容器,详见站点功能说明。
::: steps
1. 打开设置页面
点击右上角头像 → 设置
2. 修改昵称
输入新昵称后保存
:::- 打开设置页面 点击右上角头像 → 设置
- 修改昵称 输入新昵称后保存
::: timeline
- 建站立项
time="2024-09" type="tip"
首页与首批词条上线。
- 全站改版
time="2025-03" line="dashed"
迁移至新主题。
:::建站立项
首页与首批词条上线。
2024-09
全站改版
迁移至新主题。
2025-03
组件
正文中可直接使用的常用组件(参数详见站点功能说明):
| 组件 | 用途 |
|---|---|
<RepoCard repo="vuejs/vitepress" /> | GitHub 仓库卡片(星标、License、可见性) |
<Gallery>…图片…</Gallery> | 图片画廊(等高铺满排版) |
<WikiSwiper>…图片…</WikiSwiper> | 横滑轮播 |
<AppCards :links="[…]"> | 应用卡片网格 |
<DownloadPageImage /> | 页面分享长图下载按钮 |
组件与 Markdown 混写的注意点
<Gallery>、<WikiSwiper> 等包裹型组件的标签与内部内容之间必须留空行,内容才会被当作 Markdown 解析;links 这类属性值里不会渲染 Markdown 语法。
数学公式
$E=mc^2$ 行内公式、$$…$$ 独立公式段(站点已启用 KaTeX)。
思维导图
用 markmap 语言名的代码块渲染可缩放的思维导图,块内写普通 Markdown 列表,适合章节知识结构梳理:
```markmap
- 章节主题
- 子节点一
- 子节点二
```
评论