跳转至主内容
Version: 2.0.0-beta.9

创建文档

创建名为 greeting.md 的 Markdown 文件,把它放在 docs 目录下。

website # 您站点的根目录
├── docs
│   └── greeting.md
├── src
│   └── pages
├── docusaurus.config.js
├── ...

在文件顶部的前言中指定 idtitle,Docusaurus 在生成站点时将自动使用此信息。

---
id: greeting
title: 您好
---

## 来自 Docusaurus 的问候

您准备好为您的开源项目创建文档网站了吗?

### 页眉

将显示于右上方的目录

这样,您的用户不用通读全文即可知晓这篇文章的主要内容。

### 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.

- 列表将帮助您
- 阐述让用户牢记的关键点
- 您还可以将其嵌套
- 很多次

### 自定义页眉 ID {#custom-id}

使用 `{#custom-id}` 语法,您可以设置自己的页眉 ID。

浏览器中的渲染效果如下:

http://localhost:3000

来自 Docusaurus 的问候

您准备好为您的开源项目创建文档网站了吗?

页眉

将显示于右上方的目录

这样,您的用户不用通读全文即可知晓这篇文章的主要内容。

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.

  • 列表将帮助您
  • 阐述让用户牢记的关键点
    • 您还可以将其嵌套
      • 很多次

自定义页眉 ID

使用 {#custom-id} 语法,您可以设置自己的页眉 ID。

note

All files prefixed with an underscore (_) under the docs directory are treated as "partial" pages and will be ignored by default.

Read more about importing partial pages.

文档标签

你可以选择对某些文档页面添加标签,这使得你除了文档侧边栏之外,又引入了一个分类维度。 在文档导言中,声明一个标签列表:

---
id: doc-with
title: 一篇包含标签的文档
tags:
- 演示
- 开始
- -
tip

Tags can also be declared with tags: [Demo, Getting started].

Read more about all the possible Yaml array syntaxes.