搭建
搭建流程
1.初始化
npx create-docusaurus@latest my-website classic
2.启动
npm start
3.布局修改 https://icodex.me/
# 附
好看的网站 https://ai-speaker.com/
各目录一句话速查
| 目录 / 文件 | 一句话 |
|---|---|
docusaurus.config.js | 站点的全部配置,修改标题、导航、主题都在这 |
sidebars.js | 文档侧边栏菜单怎么排 |
blog/ | 写博客,Markdown → 自动生成文章页 + RSS + 标签 |
docs/ | 写文档,Markdown → 自动生成带侧边栏的文档站 |
src/pages/ | 自己写 React 页面(首页就在这) |
src/components/ | 自己写 React 组件 |
src/css/custom.css | 覆盖主题样式(改颜色、字体等) |
static/ | 放图片、favicon 等不需要构建的文件 |
.docusaurus/ | 内部缓存,别动,出问题就删掉重来 |
node_modules/ | 第三方依赖 |
常用命令
| 命令 | 用途 |
|---|---|
npm start | 启动开发服务器,自动打开浏览器,支持热更新 |
npm run build | 生成生产环境静态文件到 build/ 目录 |
npm run serve | 本地预览构建后的产物 |
npm run clear | 删除 .docusaurus/ 缓存(出问题先试试这个) |
npm run deploy | 部署到 GitHub Pages(需额外配置) |
数据流概览
你写的 Markdown(docs/ + blog/)
↓ Docusaurus 编译
.docusaurus/ 里面的 JSON
↓ 浏览器加载
网站页面渲染
- MDX = Markdown + JSX(可以在 Markdown 里直接写 React 组件)
- 所有页面最终都是 React 组件,但大多数情况下你只需要写 Markdown