Criar um documento

Um documento é uma página que pode ser criada em Markdown ou MDX, com o intuito de orientar o usuário a chegar no seu objetivo.

dica

Sugerimos que você acesse o tutorial Markdown em 60 segundos. Para mais informações consulte o Guia oficial de Markdown.

Organização dos documentos

A organização é fundamental para manter o seu site atualizado, além de ajudar na colaboração.

website # Pasta raiz do portal
│── docs
│   └── introducao.md
│   └── minha-pasta
│       └── meu-documento.md
│── src
│   └── pages
│── docusaurus.config.js
│── ...

Metadados

Os Metadados são informações adicionais que ajudam com o SEO, além de auxiliar na organização do conteúdo, são elas:

Title: Utilizado para dar nome a página no menu lateral.
Authors: Utilizado para disponibilizar a informação do autor na página.
Tags: Utilizado para filtrar conteúdos no Portal.

dica

Saiba mais sobre outros metadados.

Aqui está um exemplo de uma página com metadados:

---
title: Minha nova página
authors: Meu nome
tags: [docs]
---

## Minha primeira página

Esta é a minha primeira página em markdown.

No portal veremos ela desta maneira:

Minha primeira página em MD

dica

Se houver mais de uma tag, separe-as por vírgulas:

---
title: Minha nova página
authors: Meu nome
tags: [docs, releases, texto, documentação]
---

Identificador do documento

Cada documento tem um único ID. Este ID é utilizado para linkar os documentos, tanto no menu lateral como em outras páginas. Por padrão, o id é o nome do documento (sem a extensão) relativo a pasta docs.

observação

Por exemplo, o ID de minha-primeira-pagina.md é minha-primeira-pagina já o ID de minha-pasta/minha-segunda-pagina.md é minha-pasta/minha-segunda-pagina.