Docusaurus 本地开发指南
使用 Docusaurus 搭建文档与博客站点,基于 React 与 MDX,本地默认 localhost:3000 热更新。
Docusaurus 是 Meta 开源的静态站点生成器,专为技术文档、API 参考与博客设计,基于 React,支持 MDX、版本化文档、搜索插件与国际化。
快速开始
npx create-docusaurus@latest my-website classic
cd my-website
npm install
npm start默认 localhost 访问
| 用途 | 地址 |
|---|---|
| 开发服务器 | http://localhost:3000 |
| 预览生产构建 | http://localhost:3000(npm run serve) |
修改端口:npm start -- --port 3001。
常用命令
| 命令 | 说明 |
|---|---|
npm start | 开发模式,支持热更新 |
npm run build | 生成 build/ 静态站点 |
npm run serve | 本地预览构建结果 |
npm run clear | 清除缓存 |
内容组织
- 文档放在
docs/目录,博客放在blog/ - 支持 MDX,可在 Markdown 中嵌入 React 组件
- 通过
docusaurus.config.js配置导航、主题与插件
部署
构建产物 build/ 可部署到 GitHub Pages、Cloudflare Pages、Netlify 等静态托管。
小结
Docusaurus 是文档站首选方案之一,本地开发访问 **http://localhost:3000**,适合开源项目文档、内部知识库与技术博客。