Facebook Docusaurus 中文文档 建立网站

此系列文章的应用示例已发布于 GitHub: docusaurus-docs-Zh_CN. 能够 Fork 帮助改进或 Star 关注更新. 欢迎 Star.

建立网站

Docusaurus 的创造，是但愿可以让你为开源项目建立一个网站和文档变得很是简单。

在 安装 和 准备 以后，为文档建立基本网站的许多工做已经完成。

网站结构

你的网站结构看起来像下面这样：

root-of-repo
├── docs
└── website
│   └── blog
│   └── core
│       └── Footer.js
│   └── node_modules
│   └── package.json
│   └── pages
│   └── sidebars.json
│   └── siteConfig.js
│   └── static

这里假设您已经删除了与 初始化 脚本一块儿安装的 .md 示例文件。

全部的文档文件都应该做为 .md 文件放在 docs 文件夹中。 任何博客文章都应该在 blog 文件夹中。

博客帖子的格式必须为 yyyy-mm-dd-your-file-name.md

建立您的基本网站

要建立一个功能齐全的网站，您只须要执行几个步骤：

1. 将您的文档以 .md 文件的形式添加到 /docs 文件夹中，并确保每一个文件都有正确的header。 最简单的标题以下，其中 id 是连接名称（例如 docs/intro.html），title 固然是浏览器页面的标题。

   ---
   id: intro
   title: 入门
   ---
   
   这是个人 *新文件内容* ...

2. 将零个或多个文档添加到 sidebars.json 文件，以便您的文档在侧边栏中呈现，若是您想要显示它们。

   若是您不将文档添加到 sidebars.json 文件中，那么文档依然被渲染，但只能从其余文档连接到该文档，并使用已知的URL进行访问。

3. 修改 website/siteConfig.js 文件来配置网站，按照 website/siteConfig.js 的 文档 指引。
4. 建立任何的 自定义页面 和/或 自定义 website/core/Footer.js 文件来为你的网站提供页脚。
5. 将网站资源（如图像）放在 website/static/ 文件夹中。

6. 运行该网站以查看更改的结果。

   cd website
   yarn run start # 或 `npm run start`
   # 浏览 http://localhost:3000

此系列文章的应用示例已发布于 GitHub: docusaurus-docs-Zh_CN. 能够 Fork 帮助改进或 Star 关注更新. 欢迎 Star.