Funcionalidades Markdown Docs

O documentação pode usar qualquer recurso Markdown e ter alguns recursos adicionais específicos de docs.

Markdown frontmatter

Os documentos Markdown têm sua própria Markdown frontmatter

Referenciando outros documentos

Se você deseja fazer referência a outro arquivo de documento, você pode usar o caminho relativo do documento para o qual você deseja vincular.

O Docusaurus irá converter o caminho do arquivo para ser o caminho da url final do documento (e removerá a extensão .md).

Por exemplo, se você estiver na folder/doc1.md e você quer fazer referência à folder/doc2.md, folder/subfolder/doc3.md e otherFolder/doc4.md:

Estou referenciando um [document](doc2.md).
Referência a outro [documento em uma subpasta](subfolder/doc3.md).
[Documento relativo](../otherFolder/doc4.md) referências também funcionam.

tip

É melhor usar links de caminhos de arquivo relativos em vez de links relativos:

• links vão continuar trabalhando na interface do GitHub
• você pode personalizar o slugs de documentos sem precisar atualizar todos os links
• um documento versionado irá vincular a outro documento da mesma versão
• links relativos provavelmente serão quebrados se você atualizar a configuração de trailingSlash