Creating your site · Docusaurus

O Docusaurus foi criado com o intuito de tornar super simples a criação do site e da documentação do seu projeto de código aberto.

Após a instalação e preparação, muito do trabalho de criar um site básico para a sua documentação já foi feito.

Estrutura do site

Seu site vai ter uma estrutura parecida com esta:

root-directory
├── docs
└── website
    ├── blog
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

Isso considerando que você já excluiu os arquivos .md de exemplo que foram instalados com o script de inicialização.

Todos os arquivos da sua documentação devem ser colocados dentro do diretório docs em forma de arquivos Markdown .md. Quaisquer posts de blog devem estar dentro do diretório blog.

O nome dos posts de blog precisam estar no formato AAAA-MM-DD-seu-nome-de-arquivo.md

Criando um site básico

Para criar um site completamente funcional, basta seguir alguns poucos passos:

Adicione toda a sua documentação ao diretório /docs em forma de arquivos .md, garantindo que cada arquivo tenha um cabeçalho adequado. One example header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
```
---
id: intro
title: Getting Started
---
My new content here..
```
Adicione zero ou mais documentos ao arquivo sidebars.json para que sua documentação seja renderizada em uma barra lateral, caso prefira assim.

Se você não adicionar sua documentação ao arquivo sidebars.json, a documentação será renderizada, mas as páginas dela só poderão ser linkadas a partir de outro documento e visitadas usando seus links conhecidos.

Modifique o arquivo website/siteConfig.js para configurar o seu site, seguindo as orientações dos comentários inclusos na documentação e no website/siteConfig.js.
Crie qualquer página personalizada que você precisar e/ou personalize o arquivo website/core/Footer.js, que contém o rodapé do seu site.
Coloque recursos estáticos, tais como imagens, no diretório website/static/.
Rode o site para ver o resultado das suas alterações.

cd website
yarn run start # or `npm run start`
# Navigate to http://localhost:3000

Personalizações especiais

Página inicial da documentação

Caso você prefira que a sua página inicial leve direto para a documentação, você pode fazer isso através de um redirecionamento.

Exclua o arquivo index.js no diretório website/pages caso ele exista.
Adicione uma página estática index.html personalizada no diretório website/static com o seguinte conteúdo:

<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="UTF-8" />
    <meta
      http-equiv="refresh"
      content="0; url=docs/id-of-doc-to-land-on.html"
    />
    <script type="text/javascript">
      window.location.href = 'docs/id-of-doc-to-land-on.html';
    </script>
    <title>Your Site Title Here</title>
  </head>
  <body>
    If you are not redirected automatically, follow this
    <a href="docs/id-of-doc-to-land-on.html">link</a>.
  </body>
</html>

Você pode obter o id do documento que vai ser a página inicial a partir dos metadados dele, presentes no arquivo .md do documento.

Apenas blog

Você também pode usar o Docusaurus para hospedar apenas o seu blog.