Facebook Docusaurus 中文文档 自定义页面

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

自定义页面

您能够将网页添加到您的网站，而不是做为标准文档或博客 markdown 文件的一部分。 你能够经过在 website/pages 目录中添加 .js 文件来实现。 这些文件是 React 组件，并调用 render() 来建立它们，由CSS类等支持。

自定义主页

开始自定义主页的最简单方法是使用运行 Docusaurus 初始化脚本 时 建立 的示例网站。

你能够 启动 你的本地服务器并跳转到 http://localhost:3000 来查看示例主页的样子。 从那里，编辑 website/pages/en/index.js 文件及其各个组件以使用您想要的项目的图像和文本。

添加其它自定义页面

Docusaurus 在 website/pages/en 目录中提供了一些简单的示例页面，包括 index.js，users.js 和 help.js。 这些是展现如何为 Docusaurus 建立自定义页面的很好的例子。

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

固然，你也能够自由地写你本身的网页。 强烈建议您至少有一个索引页面，而没有提供的页面是强制性的以包含在您的网站中。 有关如何使用提供的组件或包括您本身的更多信息能够在这里找到。 有关如何连接到页眉导航栏中的不一样页面的信息能够在这里找到。

若是你想让你的页面显示在你的导航头文件中，你须要更新 siteConfig.js 来添加到 headerLinks 元素。 例如 { page: "about-slash", label: "About/"}

添加静态页面

也可使用静态 .html 文件，但默认状况下，它们不包括 Docusaurus 的页眉，页脚或样式。 这些能够像其余 静态资源 同样添加到 static 文件夹中。 或者，它们能够放在 pages 文件夹中，而不是从 React 中渲染。

若是你想使用 Docusaurus 的样式表，你能够在 ${baseUrl}css/main.css 中访问它。 若是你想为这些静态页面使用单独的 css，你能够经过将它们添加到 siteConfig.js 中的 siteConfig.separateCss 字段来排除它们与 Docusaurus 的样式的关联。

自定义网站页脚

从运行 Docusaurus 初始化脚本 时 建立 的示例 core/Footer.js 文件开始，编辑页脚以包含您网站上的任何连接或其余您但愿拥有的网站。

所提供的示例有三列，左侧有一个页脚图像，Facebook 的开放源代码标识和版权在底部。 若是您的项目不是 Facebook 开源项目，请删除徽标和版权。 固然，您也能够随意创造页脚，让它看起来成为您想要的样子！

可能提供的连接的一些建议：Docs，API，Twitter，Discord，Facebook groups，Stack Overflow，GitHub等

您的页脚将自动应用到您网站上的全部页面，包括文档和博客文章。 惟一的例外是你所包含的任何静态 html 页面。

若是你不想为你的站点添加页脚，把 core/Footer.js 的 render 函数改成返回 null。 例如:

const React = require("react");

class Footer extends React.Component {
  render() {
    return null;
  }
}

module.exports = Footer;

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