Skip to main content
Version: 2.0.0-beta.3

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β”œβ”€β”€ ...

At the top of the file, specify id and title in the front matter, so that Docusaurus will pick them up correctly when generating your site.

---id: greetingtitle: Hello---
## 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
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
### Custom id headers {#custom-id}
With `{#custom-id}` syntax you can set your own header id.

This will render in the browser as follows:

http://localhost:3000

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

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

Custom id headers#

With {#custom-id} syntax you can set your own header id.