跳到主要内容

Docusaurus 文档系统

这是一个使用 Docusaurus 搭建的文档系统，用于管理和展示项目文档。

项目结构​

docs/
├── docs/          # 文档内容目录
├── src/           # 源代码目录
├── static/        # 静态资源目录
├── docusaurus.config.js  # 主配置文件
└── sidebars.js    # 侧边栏配置

主要命令​

  • npm start - 启动开发服务器
  • npm run build - 构建生产版本
  • npm run serve - 本地预览构建后的网站
  • npm run deploy - 部署到 GitHub Pages
  • pkill -f docusaurus - 停止

访问方式​

开发服务器启动后，可以通过以下地址访问文档网站：

文档编写​

  1. 在 docs/ 目录下创建 .md 或 .mdx 文件来编写文档
  2. 支持 Markdown 和 MDX（Markdown + JSX）格式
  3. 可以使用 React 组件来增强文档内容

自定义配置​

网站配置​

编辑 docusaurus.config.js 文件来修改：

  • 网站标题
  • 网站描述
  • 主题设置
  • 导航栏配置
  • 页脚配置
  • 其他全局设置

导航配置​

编辑 sidebars.js 文件来配置：

  • 文档的导航结构
  • 侧边栏分组
  • 文档排序

开发指南​

  1. 安装依赖：
npm install
  1. 启动开发服务器：
npm start
  1. 构建生产版本：
npm run build
  1. 预览构建后的网站：
npm run serve

部署​

使用以下命令将网站部署到 GitHub Pages：

npm run deploy

主题和样式​

Docusaurus 提供了多种主题和样式选项：

  • 支持自定义 CSS
  • 支持自定义组件
  • 支持暗色/亮色模式切换
  • 支持响应式设计

插件和扩展​

Docusaurus 支持多种插件来扩展功能：

  • 搜索插件
  • 分析插件
  • 评论插件
  • 其他自定义插件

贡献指南​

  1. Fork 项目
  2. 创建特性分支
  3. 提交更改
  4. 推送到分支
  5. 创建 Pull Request

许可证​

MIT License