Introdução ao Documentos

O recurso docs fornece aos usuários uma maneira de organizar arquivos Markdown em um formato hierárquico.

info

Check the Docs Plugin API Reference documentation for an exhaustive list of options.

ID do documento

Cada documento tem um id único. Por padrão, um id de documento é o nome do documento (sem a extensão) em relação ao diretório de documentos de raiz.

Por exemplo, greeting.md id é greeting e guide/hello.md id é guide/hello.

website # Root directory of your site└── docs   ├── greeting.md   └── guide      └── hello.md

No entanto, a última parte do id pode ser definida por usuário no fronmatter. Por exemplo, se o conteúdo do guide/hello.mdfor definido como abaixo, seu id final é guide/part1.

---id: part1---Lorem ipsum

Se você quer mais controle sobre a última parte da URL do documento, é possível adicionar um slug (o padrão é o id).

---id: part1slug: part1.html---Lorem ipsum

note

É possível usar:

• slugs absolutas: slug: /mySlug, slug: /...
• slugs relativas: slug: mySlug, slug: ./../mySlug...

Documentação da página inicial

Se você deseja que um documento esteja disponível na raiz e tenha um caminho como https://docusaurus. o/docs/, você pode usar a página inicial do slug:

---id: my-home-docslug: /---Lorem ipsum

Modo somente documentos

Se você quer apenas o recurso de documentação, você pode executar seu site Docusaurus 2 sem uma página inicial e exibir sua página de documentação como a página de índice.

Para ativar o modo somente docs, defina o plug-in docs routeBasePath: '/ e use o frontmatter slug: / no documento que deve ser a página index ([mais informações](# home-page-docs)).

caution

Você deve apagar a página inicial existente em ./src/pages/index.js, ou então haverá dois arquivos mapeando para a mesma rota!

tip

Também há um "modo somente blog" para aqueles que só querem usar o recurso do blog do Docusaurus 2. Você pode usar o mesmo método detalhado acima. Siga as instruções de instalação no Modo somente Blog.