主题
Markdown 写作速查
本站基于 VitePress 构建,除了标准 Markdown,还支持一些好用的扩展语法。新增文章时可以直接参照本页。
新建一篇文章
- 在
docs/对应目录下新建.md文件,例如docs/notes/my-post.md; - 在文件顶部写好 frontmatter:
md
---
title: 文章标题
description: 一句话摘要,会用于搜索引擎描述
---- 在
docs/.vitepress/config.mts的sidebar中加入链接,侧边栏就会出现这篇文章。
基础语法
| 效果 | 写法 |
|---|---|
| 加粗 | **加粗** |
| 斜体 | *斜体* |
行内代码 | `行内代码` |
| 链接 | [链接](/about) |
| 图片 |  |
提示框
信息
用于补充说明。
提示
用于推荐做法。
注意
用于需要留意的地方。
危险
用于可能造成损失的操作。
md
::: tip 提示
用于推荐做法。
:::代码组
bash
npm install vitepress -Dbash
pnpm add vitepress -D卡片导航
本站自带 CardGrid 组件,可以在任意文章里插入卡片导航:
md
<CardGrid :items="[
{ icon: '🖥️', title: '把玩服务器', desc: '服务器初始化与安全加固', link: '/vps/settings/ubuntu' }
]" />效果: