微精弘开发文档

使用 VitePress 构建

若有使用问题，请翻阅相关文档，或询问社区

如何编写文档

首先请确认你是否有文档的编辑权限

如果你有前端开发环境，推荐 clone 仓库到本地构建。

如果没有前端开发环境，推荐使用 Github Codespace，创建远程前端环境。 在仓库首主页点击Code，选择Codespaces选项卡创建 Codespace。 Codespace 会自动拉取仓库代码，同时安装项目必要依赖。 若因网络质量问题没有自动下载依赖，请手动使用命令安装依赖。

pnpm i

安装好依赖后以开发模式启动项目

pnpm docs:dev

此时会在 本地 开启一个端口，浏览器打开相应地址即可。 若使用 Codespace，启动项目后，需要在控制台选项卡选择 PORT， 应该能看到一个已开启的端口，点击链接即可打开文档预览页面

推荐使用本地编辑器编写文档文件，仅在提交时使用 Codespace 以预览构建效果

目录结构

• /docs/.vitepress/config.js 配置文件，侧栏之类的这里配置
• /docs/index.md HOME PAGE 配置
• /docs/**/*.md 文档，按照文档类别写在相应文件夹中

其他文件一般不需要修改