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
- and you may nest them