Translate

Site Preparation

完成安装 Docusaurus 一节中的步骤之后，你现在有了一个可以为具体的网站服务的框架。 接下来我们来探讨 Docusaurus 构架的各个部分，以便你准备你的网站。

目录结构

完成安装 Docusaurus 一节中的步骤后, 初始化脚本创建了一个目录结构，其类似于：

root-directory
├── .gitignore
├── docs
│   ├── doc1.md
│   ├── doc2.md
│   ├── doc3.md
│   ├── exampledoc4.md
│   └── exampledoc5.md
└── website
    ├── blog
    │   ├── 2016-03-11-blog-post.md
    │   ├── 2017-04-10-blog-post-two.md
    │   ├── 2017-09-25-testing-rss.md
    │   ├── 2017-09-26-adding-rss.md
    │   └── 2017-10-24-new-version-1.0.0.md
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

目录介绍

• 文档源文件：目录 docs 下包含了用 Markdown 编写的示例文档。
• 博客：目录 website/blog 下包含了用 Markdown 编写的示例博文。
• 页面：目录 website/pages 下包含了示例的网站上层页面。
• 静态文件和图片：目录 website/static 下包含了示例站点中用到的静态资源。

关键文件

• 页脚：文件 website/core/Footer.js 是一个 React 组件，用于生成 Docusaurus 站点的页脚，内容应由用户定制。
• 配置文件：文件 website/siteConfig.js 是 Docusaurus 的主配置文件。
• 侧边栏：文件 sidebars.json 指定了文档文件的结构和出现顺序。
• .gitignore: 文件 .gitignore 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。

准备说明

你不能删除文件 website / siteConfig.js 或 website / core / Footer.js，但是可以根据需要编辑它们。 文件 website/siteConfig.js 中的字段 customDocsPath 的值，可以被修改，如果你希望使用别的目录名或路径。 也可以将目录 website 重命名为你想要的任意名称。

但是，你需要保留目录 website/pages 和 website/pages。 你可以随意地改变里面的内容。 在一个最最精简的 Docusaurus 站点中，你至少要保证目录 website/pages 中存在文件 en/index.js 或 en/index.html，而且目录 website/static 下要有一张图像，用作网页头部的图标。

如果你的目录中不存在文件 .gitignore，我们会出于列举被忽略文件的需要生成一个。 一般来说，应该忽略所有的 node_modules、build 文件、系统文件（.DS_Store）、日志文件等。 这里有一个更全面的清单，列举了在 Node.js 项目中通常被忽略的内容。