docusaurus的使用曾构建过小邮助手（邮储银行交易操作文档说明）

Docusaurus 能够帮助你建立并发布 美观的文档网站。

是一个静态网站生成器。它发挥了 React 的全部功能来构建具有快速客户端导航的 单页应用，从而赋予你的网站交互性。它提供了开箱即用的
文档功能，还能用于创建任何类型的网站（例如个人网站、产品介绍、博客、营销页等等）

示例

博客主页

大概就是上面那个样子，可以设置自己的主题，分类，写自己的文章，做笔记等

需要支持docusaurus的环境，可以去docusaurus中文官网看，基本需要nodeJS14版本以上，我们这里主要就说一下项目结构，有时候看官网太散，又是大部分英文，所以我觉得还是有必要记录一下笔记的。

项目结构

通过官网提供的命令，建好自己的项目后，大概就是以下层级，下面我们就来说说它们的具体作用。

• blog/ - 包含博客的 Markdown 文件。如果你不想或不需要博客，则可以将此目录删除。在 博客功能指南文档中可以找到更多详细信息

• /docs/ - 包含文档的 Markdown 文件。可在 sidebars.js中自定义文档侧边栏的顺序。在 文档功能指南 中可以找到更多详细信息

• /src/ - 非文档文件，例如独立页面（pages）或自定义的 React 组件。你不必严格地将非文档文件放到这里，但是将它们集中在此目录下可以更轻松地进行管理，以便您需要进行某些格式校验或处理 /src/pages - 此目录中的所有文件都将转换为网站的独立页面(page)。 可以在 独立页面（pages）指南 中找到更多详细信息

• /static/ - 存放静态文件的目录。此处的所有内容都将被复制到最终的 build 目录的根目录下

• /docusaurus.config.js - 包含站点配置的配置文件。与 Docusaurus 1 中siteConfig.js 文件等价

• /package.json - Docusaurus 网站也是一个 React 应用程序。你可以在其中安装和使用所需的任何 npm 软件包

• /sidebar.js - 生成文档时使用此文件来指定侧边栏中的文档顺序

docusaurus.config.js

docusaurus.config.js 包含了您站点的配置信息，位于您网站的根目录。也就是下图这个位置

通常导出站点配置对象：

module.exports = {
  // site config...
};

config中定义基本必须字段

配置文件也支持配置创建器函数和异步代码。

module.exports = function configCreator() {
  return {
    // site config...
  };
};
module.exports = async function configCreatorAsync() {
  return {
    // site config...
  };
};
module.exports = Promise.resolve({
  // site config...
});

必填字段

title
类型：string
网站标题

module.exports = {
  title: '半糖学前端',
};

url
类型：string
网站网址

module.exports = {
  url: 'https://docusaurus.io',
};

baseUrl
类型：string

您站点的相对路径。 您可将其视为是主机名后的路径。 For example, /metro/ is the base URL of
https://facebook.github.io/metro/. 对于没有路径的网址，baseUrl 应设置为 /。 此字段与 url
字段相对。

module.exports = {
  baseUrl: '/',
};