Skip to content

Markdown 进阶语法指南

发表于 2025-03-17
更新于 2026-03-02
阅读量 加载中...

在 VitePress 项目中,Markdown 有一些特殊的进阶用法,本文将逐一介绍。

标题

二级标题的分割线

在Job Compass项目中,二级标题(##)在编译后会自动在上方添加一条分割线,增强文档的结构感。 比如上面的标题

去掉AI水印

很多AI生成markdown时喜欢加入分割线,在编辑时往往需要手动删除

标题与 Outline 关键字

Outline 关键字用于配置页面的导航栏显示规则。例如,在页面开头配置如下内容:

text
outline: deep

它的作用是让页面导航按层级结构显示所有标题,便于快速浏览文档结构。

标题无需手动加粗

在 Markdown 中,所有级别的标题在编译过程中都会自动被加粗处理,因此在书写标题时无需额外添加加粗标记。

换行规则

在 VitePress 中,Markdown 的换行遵循标准规范,通常需要空一行才能实现真正的换行效果。

示例说明

以下写法无法实现换行

text
第一行字,但在编辑器中只按一次回车。
虽然编辑器换了行,但编译后不会换行。

效果如下:

第一行字,但在编辑器中只按一次回车。 虽然编辑器换了行,但编译后不会换行。

而以下写法可以正常换行

text
第一行字,但在编辑器中按两次回车,也就是中间空一行

这一行编译后就换到了新的一行

效果如下:

第一行字,但在编辑器中按两次回车,也就是中间空一行

这一行编译后就换到了新的一行

掌握这些细节,能让你的文档在 VitePress 中呈现得更规范、更清晰。

相关文章