Create a doc
Create a Markdown file, greeting.md
, and place it under the docs
directory.
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
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.
Doc front matterβ
The front matter is used to provide additional metadata for your doc page. Front matter is optionalβDocusaurus will be able to infer all necessary metadata without the front matter. For example, the doc tags feature introduced below requires using front matter. For all possible fields, see the API documentation.