如何添加文档
以后忘了怎么操作,回来看这一篇就够了。
方式一:直接在 GitHub 网页上添加(最简单,手机也行)
打开仓库
github.com/weisunit/my-docs进入
docs/目录,点右上角 Add file → Create new file文件名输入
guide/my-note.md(支持多级目录,以/分隔)用 Markdown 写内容,文件开头建议加上标题:
md# 我的笔记标题 正文内容……支持 **加粗**、`代码`、表格、图片等所有 Markdown 语法。拉到底点 Commit changes
等待 1~2 分钟,Vercel 自动构建上线 🎉
注意:新文件如果想在左侧边栏出现,需要编辑
docs/.vitepress/config.mts, 在sidebar里加一行{ text: '我的笔记', link: '/guide/my-note' }。
方式二:整个文件夹一起上传(推荐,侧边栏自动生成)
把你的笔记文件夹放进 docs/notes/,子文件夹会自动变成侧边栏分组,无需改任何配置:
docs/notes/ ← 笔记根目录
├── index.md ← 笔记区首页(已有)
├── 工作/
│ ├── 01-周报.md → 侧边栏分组「工作」下的「周报」
│ └── 02-计划.md
└── 学习/
├── 前端/
│ └── Vue入门.md → 支持任意层级嵌套
└── 英语/单词.md本地推送:
bash
# 把你的笔记文件夹拷进 docs/notes/
cp -r ~/我的笔记/* docs/notes/
git add . && git commit -m "上传笔记" && git push文件名支持中文;建议用
01-、02-这样的数字前缀控制排序(显示时前缀会自动去掉)。
方式三:在本地写,然后推送
bash
cd my-docs
# 1. 把你的 .md 文件放进 docs/(或 docs/guide/ 等子目录)
# 2. 本地预览(可选)
npm run docs:dev
# 3. 提交并推送
git add .
git commit -m "添加我的文档"
git push推送后 Vercel 自动部署,什么都不用再点。
常用 Markdown 语法速查
| 语法 | 效果 |
|---|---|
# 标题 | 一级标题(会出现在右侧"本页目录") |
**粗体** | 粗体 |
`代码` | 行内代码 |
代码块 | 代码块(带语法高亮) |
[文字](链接) | 超链接 |
> 引用 | 引用块 |
- 列表 | 无序列表 |
代码块示例
js
export default {
name: 'VitePress 支持语法高亮'
}提示容器
VitePress 还支持 ::: tip、::: warning、::: danger 提示容器。