VitePress快速上手
可以直接在 vitepress官网 查看快速上手教程,跟着做就可以快速搭建起一个项目
项目创建
操作笔记参考官网文档: https://vitepress.dev/guide/getting-started
创建目录
shell
mkdir vitepress-tutorial
cd vitepress-tutorial
安装依赖
shell
pnpm add -D vitepress
初始化项目
shell
npx vitepress init
TIP
项目的更目录非常重要。新手建议从 ./docs
开始,并且不要选择自定义主题。
目录结构
.
├─ docs
│ ├─ .vitepress # 当前目录所在的位置就是文档的根目录
│ │ └─ config.js # 项目的配置文件,最重要
│ ├─ api-examples.md
│ ├─ markdown-examples.md
│ └─ index.md
└─ package.json
路由
https://vitepress.dev/guide/routing
文件路由
导航
详见基础配置章节
侧边栏
详见基础配置章节
项目部署
https://vitepress.dev/guide/deploy
在使用 vitepress
的之后需要特别注意不能在 markdown
中写一些的代码,例如 <前端未闭合标签>
、 {}
、location
。因为 vitepress
在运行过程中会识别前端标签并进行转义,如果标签为闭合就会报错。而 {}
会被识别为 javascript
的变量,如果没有处理好也会报错,最后的 location
是在构建打包文件时会报错。
如果不需要权限拦截,当访问量小时最好的方案是采用
- gitee pages、github pages 静态页面托管。
- 腾讯云 cos 的存储桶部署。
- 腾讯云服务器部署(后端权限拦截必须要服务器)