next

Translate

Creating your site

Docusaurus 旨在使为开源项目创建站点和文档的工作变得超级简单。

在完成安装和建站准备两个章节中的步骤之后，为你的文档创建基础站点的工作就基本上完成了。

站点结构

你的网站结构看上去像这样：

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

当然，前提是假设你已经删除了所有由初始化脚本所生成的示例的 .md 文件。

你所有的文档文件，都应该以 Markdown .md 文件的格式放置在 docs 文件夹下。 任何博客文章都应放在 blog 文件夹下。

博文文件命名格必须统一为 YYYY-MM-DD-your-file-name.md

创建一个基础的站点

要建立一个功能完备的站点，你只需要完成以下几个步骤：

  1. 在目录 /docs 下添加你的 .md 文件，确保每个文件中都含有适当的 header 数据。 以下是一个示例的 header，其中，id 是文档链接的名称（例如，docs/intro.html），title 是网页的标题。

    ---
id: intro
title: 使用入门
---
这是新的段落……

  2. 把文档记录在文件 sidebars.json 里，随后你就能够通过侧边栏访问这些文档了。

没有记录在文件 sidebars.json 中的文档，也能被正常渲染，但是只能从其他文档中获得指向它们的链接，而且只有知道确切的 URL 才能访问它们。

  1. 参考 docs 及 website/siteConfig.js 中的注解修改文件 website/siteConfig.js，以此配置你的站点。
  2. 创建任意自定义页面，和/或自定义文件 website/core/Footer.js，该文件定义了你网站的页脚。
  3. 在目录 website/static/ 下放置资源文件，例如放置一些图像。
  4. 运行站点，以查看修改后的效果。
cd website
yarn run start # 或者 `npm run start`
# 转到 http://localhost:3000

特殊设定

把文档设置为着陆页

如果你希望着陆页直达某个文档，可以通过重定向来实现。

  1. 删除目录 website/pages 下的文件 index.js，如果该文件存在的话。
  2. 在目录 website/static 下新建自定义页面 index.html，填入以下内容：
<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="UTF-8" />
    <meta
      http-equiv="refresh"
      content="0; url=docs/id-of-doc-to-land-on.html"
    />
    <script type="text/javascript">
      window.location.href = 'docs/id-of-doc-to-land-on.html';
    </script>
    <title>Your Site Title Here</title>
  </head>
  <body>
    If you are not redirected automatically, follow this
    <a href="docs/id-of-doc-to-land-on.html">link</a>.
  </body>
</html>

着陆页文档的 id，可以从该文档的 .md 文件的元数据中取得（译注：即前面提到的 header 数据中的 id）。

仅启用博客

你也可以将 Docusaurus 仅仅用于搭建博客。

← Site PreparationPublishing your site →