Docusaurus

Docusaurus é um gerador de sites estáticos construído com React e Node.js. Ele pega seus arquivos Markdown e cria um site completo de documentação com todos os recursos que os usuários esperam. Diferente de construir um site do zero, o Docusaurus cuida das partes difíceis para você.

A ferramenta usa MDX, o que significa que você pode adicionar componentes React interativos diretamente dentro dos seus arquivos Markdown. Isso torna sua documentação mais envolvente sem trabalho extra. Ela vem com busca integrada alimentada pela Algolia, gerenciamento de versões para diferentes lançamentos de produtos e suporte para mais de 70 idiomas por meio de ferramentas de tradução.

Como cria arquivos estáticos, sua documentação carrega rapidamente e pode ser hospedada em qualquer lugar. Os sites funcionam muito bem em dispositivos móveis e seguem os padrões modernos da web para velocidade e acessibilidade.

Começar com o Docusaurus é simples e leva apenas alguns minutos:

• Instale o Node.js versão 20 ou superior no seu computador, depois execute o comando de configuração no seu terminal para criar um novo site.

• Escreva sua documentação em arquivos Markdown dentro da pasta docs. Cada arquivo se torna uma página no seu site.

• Personalize o visual editando o arquivo de configuração. Você pode mudar cores, adicionar seu logo e configurar menus de navegação.

• Use o comando de visualização local para ver as alterações instantaneamente no seu navegador enquanto trabalha.

• Adicione posts no blog criando arquivos Markdown na pasta blog com datas no nome do arquivo.

• Quando estiver pronto para publicar, execute o comando de build para gerar arquivos estáticos, depois faça o upload para qualquer hospedagem web como GitHub Pages, Netlify ou Vercel.

A ferramenta inclui guias detalhados e uma comunidade útil caso você tenha dúvidas.

• Gratuito e de código aberto com licença MIT

• Construído com React e Node.js

• Escreva conteúdo em Markdown e MDX

• Busca integrada com Algolia DocSearch

• Gerenciamento de versões para lançamentos de produtos

• Suporte para mais de 70 idiomas

• Blog e documentação em um único site

• Modo escuro e design responsivo

• Geração rápida de site estático

• Implantação fácil em qualquer host