常见问题

项目如何启动？

环境准备

• Node.js ≥ 18（建议 LTS）
• 包管理器：pnpm（推荐）或 npm

npm i -g pnpm

获取与安装

git clone https://github.com/SZMOFEI/my-docs.git
cd my-docs

# 安装依赖（择一）
pnpm i
# 或
npm i

本地开发与构建

# 启动开发预览
pnpm docs:dev
# 或
npm run docs:dev
# 默认地址：http://localhost:8080

# 生产构建
pnpm docs:build
# 或
npm run docs:build
# 构建产物：src/.vuepress/dist

如何开发一个页面？（开发SOP）

认识项目结构

.
├── .github (可选的) → GitHub 配置文件存放路径
│    └── workflow → GitHub 工作流配置
│         └── docs-deploy.yml → 自动部署文档的工作流
│
├── src → 文档文件夹
│    │
│    ├── .vuepress (可选的) → VuePress 配置文件夹
│    │    │
│    │    ├── dist (默认的) → 构建输出目录
│    │    │
│    │    ├── public (可选的) → 静态资源目录
│    │    │
│    │    ├── styles (可选的) → 用于存放样式相关的文件
│    │    │
│    │    ├── config.{js,ts} (可选的) → 配置文件的入口文件
│    │    │
│    │    └── client.{js,ts} (可选的) → 客户端文件
│    │
│    ├── XXX → 分类项目的页面存放内容
│    │
│    └── README.md → 项目主页
│
└── package.json → Nodejs 配置文件

常用修改、增加 READM.md 文件

在 XXX 目录下增加一个目录或者文件 ， README.md 或者添加一个目录

.\src\.vuepress\navbar\zh.ts 修改对应的路由 。

再修改侧边栏的导航 src\.vuepress\sidebar\zh.ts

版本管理建议

git checkout -b feat/your-change
# 编辑...
git add .
git commit -m "feat: 描述本次修改"
git push origin feat/your-change

发布部署

• 合并代码到 master 分支
• Github Action 自动部署到静态服务器
• 访问 mohaoyang.xyz 观察是否部署成功

常见问题