快速开始
一条命令初始化,文档与博客开箱即用,版本化/i18n 可后续打开。
初始化
npm create docusaurus@latest my-docs classic
cd my-docs
npm install
npm run start
目录要点
docs/:文档 Markdown,自动生成路由与侧边栏(基于sidebars.js)。blog/:博客文章。docusaurus.config.js:站点配置(标题、导航、i18n、插件)。sidebars.js:侧边栏定义,可自动或手动。
常用脚本
- 开发:
npm run start - 构建:
npm run build(输出build/) - 预览:
npm run serve
版本化
npm run docusaurus docs:version 1.0.0
会在 versioned_docs、versions.json 中生成对应版本。
部署
- 静态托管:将
build/上传至任意 CDN/静态托管(CF Pages/Netlify/Vercel)。 - GitHub Pages:可用官方
docusaurus deploy(需配置url与baseUrl)。
