Translate

建站准备

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

目录结构

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

root-directory
├── 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

目录介绍

• Documentation Source Files: The docs directory contains example documentation files written in Markdown.
• Blog: The website/blog directory contains examples of blog posts written in markdown.
• 页面：包含示例网站顶级页面的文件夹 website/pages。
• 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。

关键文件

• 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
• 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
• Sidebars: The sidebars.json file contains the structure and order of the documentation files.

准备说明

You will need to keep the website/siteConfig.js and website/core/Footer.js files but may edit them as you wish. The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. At the bare minimum, you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.