创建文档

创建一个 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 目录下所有以下划线 (_) 为前缀的文件都被视为“部分”页面，默认情况下将被忽略。

阅读更多关于 导入部分页面 的内容。

文档前置 matter

前置 matter 用于为您的文档页面提供额外的元数据。前置 matter 是可选的——Docusaurus 能够在没有前置 matter 的情况下推断所有必要的元数据。例如，下面介绍的 文档标签 功能需要使用前置 matter。有关所有可能的字段，请参阅 API 文档。

文档标签

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

可以内联定义标签，也可以引用在 标签文件 中声明的预定义标签（可选，通常为 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。默认情况下，文档 id 是相对于根文档目录的文件名（不包括扩展名）。

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

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

但是，id 的**最后一部分**可以在 front matter 中由用户定义。例如，如果 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

在所有情况下，默认 slug 仅为 /Guides，不包含 /index、/README 或重复的 /Guides 段。

注意

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

使用 slug front matter 更改文档的 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：slug: /mySlug、slug: /...
• 相对 slug：slug: mySlug、slug: ./../mySlug...

如果希望文档在根目录下可用，并且路径类似于 https://docusaurus.org.cn/docs/，则可以使用 slug front matter

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

Lorem ipsum

侧边栏

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

我们建议的文件系统组织方式是：使文件系统镜像侧边栏结构（这样您就不需要手动编写 sidebars.js 文件），并使用 slug front matter 自定义每个文档的 URL。