docs: fix contributing

This commit is contained in:
camera-2018
2023-04-26 20:01:34 +08:00
parent f2e61cc6d0
commit dc15bf4373

View File

@@ -42,10 +42,22 @@ npm install
npm run docs:dev #运行预览环境 npm run docs:dev #运行预览环境
``` ```
```bash ```bash
npm run docs:bulid #编译线上环境 npm run docs:build #编译线上环境
npm run docs:preview #预览线上环境 npm run docs:preview #预览线上环境
``` ```
## 图片放置指南
图片放置在当前大章节的 `static` 目录下,然后在 md 文件中使用相对路径引用。
```markdown
![](static/xxx.png)
```
注意尽量不要使用 `img` 标签,因为经前端构建解析后路径会不正确。
后续会统一放置到 oss 存储桶中。
## 项目配置指南 ## 项目配置指南
修改新添加或移动位置的 md 文件需要在 `.vitepress/config.js` 中的 `sidebar` 中添加或修改对应的配置。 修改新添加或移动位置的 md 文件需要在 `.vitepress/config.js` 中的 `sidebar` 中添加或修改对应的配置。