Criar um documento
Crie um arquivo Markdown, greeting.md
, e coloque no diretório docs
.
website # root directory of your site├── docs│ └── greeting.md├── src│ └── pages├── docusaurus.config.js├── ...
No topo do arquivo, especifique id
e title
no front matter, Para que o Docusaurus as pegue corretamente ao gerar o seu 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.
Isso irá renderizar no navegador da seguinte forma:
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
#
Custom id headersWith {#custom-id}
syntax you can set your own header id.