Create a Doc

创建一个Markdown文档 greeting.md, 然后放在 docs 目录下:

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

在文档顶部的元数据里指定 id 和 title, 之后docusaurus就会能够正确识别病生成你的网站:

docs/greeting.md

---
id: greeting
title: Hello
---

## Hello from Docusaurus

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

note

docs目录中, 所有以下划线(_)开头的文件都被视为部分(partial)页面, 默认生成网站的时候会忽略该文件.

Doc tags

你可以给文档添加标签(tags), 这样可以创建另外一个维度的分类. 标签传给文档的元数据:

---
id: doc-with-tags
title: A doc with tags
tags:
  - Demo
  - Getting started
---

Lopra xxxx

Tip

标签也可以声明成这种格式: tags: [Demo, Getting started]. 更多信息参考 Yaml array syntaxes.