文档发布链路:
编写 -> 本地预览 -> 构建检查 -> 推送 main -> 平台自动部署
1 编写文档
在 docs/docusaurus/ 下新建或修改 .md 文件,例如:
docs/docusaurus/my-doc.md
建议使用最小 Front Matter:
---
sidebar_position: 10
title: 文档标题
description: 一句话描述
last_update:
date: 2026-02-12
author: 站点维护者
---
2 本地预览
npm start
检查 4 件事:
- 侧边栏顺序是否正确
- 链接是否可点击
- 图片是否显示
- 手机端是否可读
3 构建检查
npm run build
构建通过再发布,能提前发现死链和格式错误。
4 提交并推送
git add docs/docusaurus
git commit -m "docs: 更新文档"
git push origin main
5 自动上线
当前仓库使用静态站点构建(npm run build,产物目录 build)。
只要托管平台已绑定 main 分支,推送后会自动重新部署。
线上地址可按配置查看:https://mzb-x.pages.dev
6 可选:后台发布(Decap CMS)
- 打开
/admin/并登录 - 进入「Docusaurus 文档」
- 编辑后点击发布
- 系统会把改动写入仓库并触发部署
7 发布前隐私检查
- 不写密钥、密码、Token
- 不写真实手机号、邮箱、住址
- 示例统一用占位符(如
<your-domain>)