目标

用当前仓库快速搭建一个可写文档、可预览、可发布的网站。

1. 环境准备

• Node.js >= 20
• npm
• Git

安装依赖：

npm ci

2. 先跑起来

npm start

本地访问 http://localhost:3000，确认页面可正常打开。

3. 按当前仓库结构改内容

• 站点全局配置：docusaurus.config.ts
• 文档内容：docs/
• 博客内容：blog/
• 首页与组件：src/pages/、src/components/
• 静态资源：static/img/

新手建议先改这 3 处：

1. docusaurus.config.ts 的 title、tagline、url
2. docs/docusaurus/ 下新增你的第一篇文档
3. src/pages/index.tsx 改首页文案

4. 发布前检查

npm run build
npm run serve

重点检查：

• 链接是否可访问
• 图片路径是否正确
• 移动端是否可读

5. 发布上线（通用）

1. 将仓库推送到远程 main 分支
2. 在托管平台绑定该仓库
3. 构建命令使用 npm run build
4. 发布目录使用 build

之后每次推送 main，平台会自动重新构建并上线。

6. 隐私保护清单

• 不在文档、代码、配置中写入密钥、密码、Token
• 示例统一使用占位符（如 <your-repo>、<your-domain>）
• 对外文档避免出现真实手机号、邮箱、住址等信息