跳到主要内容

开始

它是什么?

Docusaurus 是一个基于 React 构建的帮助快速生成静态网站的工具,支持将 MDX 格式编写的文档生成静态 HTML 文件,同时还支持在 Markdown 中嵌入 React 组件。

什么情况下你能用到它?

  1. 使用 markdown 语法书写静态博客;
  2. 构建一个文档类的站点;
  3. 一个带有新闻功能和静态页面为主的官方网站;
  4. 建立一个实时代码演示效果的教程类的网站;
  5. 产品宣传的落地页;
  6. 集成搜索的个人知识库。

如何使用?

安装

npx create-docusaurus@latest my-website classic
  • my-website 项目的名称和目录名(共用)
  • classic 主题,可选(facebook)

运行

cd my-website
npx docusaurus start

使用指南

我将从博客、文档、页面几个方面详细介绍如何使用 Docusaurus 搭建一个满足各个需求的站点。

官方文档:

中文:https://www.docusaurus.cn
英文:https://docusaurus.io

注意事项

  1. 修改 sidebars.js 文件,在开发模式下,一定要重新启动才能生效;
  2. pages 目录下的 jsjsx 文件在打包的时候都会被当做一个页面渲染,如果是工具函数或者组件文件可能报错,为避免此问题,命名时可以加前缀 _