1、创建文档

创建文档

创建一个 Markdown 文件 greeting.md，并将其放在 docs 目录下。

website # root directory of your site
├── docs
│   └── greeting.md
├── src
│   └── pages
├── docusaurus.config.js
├── ...

---
description: Create a doc page with rich content.
---

# Hello from Docusaurus

Are you ready to create the documentation site for your open source project?

## Headers

will show up on the table of contents on the upper right

So that your users will know what this page is all about without scrolling down or even without reading too much.

## Only h2 and h3 will be in the TOC by default.

You can configure the TOC heading levels either per-document or in the theme configuration.

The headers are well-spaced so that the hierarchy is clear.

- lists will help you
- present the key points
- that you want your users to remember
  - and you may nest them
    - multiple times

信息

注意

docs 目录下所有带有下划线（_）前缀的文件都被视为 "partial" 页面，默认会被忽略。

了解有关导入部分页面的更多信息。

文档前题

头条新闻用于为你的文档页面提供附加元数据。前面的内容是可选的 - Docusaurus 将能够在没有前面的内容的情况下推断出所有必要的元数据。例如，下面介绍的文档标签功能需要使用 Front Matter。对于所有可能的字段，请参阅 API 文档。

文档标签

标签在前言中声明，除了文档侧边栏之外，还引入了另一个分类维度。

可以内联定义标签，或引用在 tags file 中声明的预定义标签（可选，通常为 docs/tags.yml）。

以下示例：

docusaurus 引用了在 docs/tags.yml 中声明的预定义标签键
Releases 是一个内联标签，因为它在 docs/tags.yml 中不存在

docs/my-doc.md

---
tags:
  - Releases
  - docusaurus
---

# Title

Content

docs/tags.yml

docusaurus:
  label: 'Docusaurus'
  permalink: '/docusaurus'
  description: 'Docs related to the Docusaurus framework'

提示

标签也可以用 tags: [Demo, Getting started] 声明。

详细了解所有可能的 Yaml 数组语法。

组织文件夹结构

Markdown 文件在 docs 文件夹下的排列方式会对 Docusaurus 内容生成产生多重影响。然而，它们中的大多数都可以与文件结构解耦。

文件编号

每个文档都有一个唯一的 id。默认情况下，文档 id 是相对于根文档目录的文档名称（不带扩展名）。

例如，greeting.md 的 ID 为 greeting，guide/hello.md 的 ID 为 guide/hello。

website # Root directory of your site
└── docs
   ├── greeting.md
   └── guide
      └── hello.md

然而，id 的最后一部分可以由用户在前文中定义。例如，如果 guide/hello.md 的内容定义如下，则其最终的 id 为 guide/part1。

---
id: part1
---

Lorem ipsum

信息

ID 用于在手写侧边栏或使用与文档相关的布局组件或钩子时引用文档。

文档 URL

默认情况下，文档的 URL 位置是相对于 docs 文件夹的文件路径，但也有一些例外。也就是说，如果文件被命名为以下之一，则该文件名将不会包含在 URL 中：

命名为 index（不区分大小写）：docs/Guides/index.md
命名为 README（不区分大小写）：docs/Guides/README.mdx
与父文件夹同名：docs/Guides/Guides.md

在所有情况下，默认段只有 /Guides，没有 /index、/README 或重复的 /Guides 段。

信息

这个约定与类别索引约定完全相同。但是，isCategoryIndex 配置不会影响文档 URL。

使用 slug 前面的内容更改文档的 URL。

例如，假设你的网站结构如下所示：

website # Root directory of your site
└── docs
    └── guide
        └── hello.md

默认情况下，hello.md 将在 /docs/guide/hello 可用。你可以将其 URL 位置更改为 /docs/bonjour：

---
slug: /bonjour
---

Lorem ipsum

slug 将附加到文档插件的 routeBasePath 中，默认情况下为 /docs。请参阅仅文档模式了解如何从 URL 中删除 /docs 部分。

注意

可以使用：

绝对蛞蝓：slug: /mySlug、slug: /……
相对蛞蝓：slug: mySlug、slug: ./../mySlug……

如果你希望文档在根目录下可用，并且具有类似 https://docusaurus.nodejs.cn/docs/ 的路径，则可以使用 slug front Matter：

---
id: my-home-doc
slug: /
---

Lorem ipsum

侧边栏

当使用自动生成的侧边栏时，文件结构将决定侧边栏结构。

我们对文件系统组织的建议是：让你的文件系统镜像侧边栏结构（这样你就不需要手写你的 sidebars.js 文件），并使用 slug 前面的内容来自定义每个文档的 URL。

创建文档​

文档前题​

文档标签​

组织文件夹结构​

文件编号​

文档 URL​

侧边栏​