docusaurus

Docussauro

Introdução

Docusaurus é um projeto para construir, implantar e manter facilmente sites de projetos de código aberto.

Com pouco tempo? Confira nosso tutorial de 5 minutos ⏱️!

Dica : use docusaurus.new para testar o Docusaurus imediatamente em um playground.

• Simples de começar

O Docusaurus foi construído de forma que possa começar a funcionar no menor tempo possível. Construímos o Docusaurus para lidar com o processo de construção do site para que você possa se concentrar no seu projeto.

• Localizável

O Docusaurus é fornecido com suporte de localização via CrowdIn. Capacite e expanda sua comunidade internacional traduzindo sua documentação.

• Personalizável

Embora o Docusaurus seja fornecido com as principais páginas e seções de que você precisa para começar, incluindo uma página inicial, uma seção de documentos, um blog e páginas de suporte adicionais, ele também é personalizável para garantir que você tenha um site exclusivamente seu.

Instalação

Use a CLI de inicialização para criar seu site:

npm init docusaurus@latest

Leia os documentos para obter mais informações.

Contribuindo

Lançamos o Docusaurus porque ele nos ajuda a escalar melhor e oferece suporte aos muitos projetos OSS da Meta. Esperamos que outras organizações possam se beneficiar do projeto. Agradecemos qualquer contribuição da comunidade.

Código de Conduta

A Meta adotou um Código de Conduta que esperamos que os participantes do projeto cumpram. Por favor, leia o texto completo para entender quais ações serão ou não toleradas.

Guia de contribuição

Leia nosso guia de contribuição para saber mais sobre nosso processo de desenvolvimento, como propor correções de bugs e melhorias e como construir e testar suas alterações no Docusaurus.

Bugs para iniciantes

Para ajudá-lo a se familiarizar com nosso processo de contribuição, temos uma lista de bugs para iniciantes que podem conter problemas menores para resolver primeiro. Este é um ótimo lugar para começar.

Contato

Dispomos de alguns canais de contato:

• Discórdia:
  • #general para quem usa o Docusaurus.
  • #contributors para quem deseja contribuir com o núcleo do Docusaurus.
• @docusauro X
• Problemas do GitHub

Colaboradores

Este projeto existe graças a todas as pessoas que contribuem. [Contribuir].

Apoiadores

Obrigado a todos os nossos apoiadores! Torne-se um apoiador

Patrocinadores

Apoie este projeto tornando-se um patrocinador. Seu logotipo aparecerá aqui com um link para seu site. Torne-se um patrocinador

Licença

Docusaurus é licenciado pelo MIT.

A documentação do Docusaurus (por exemplo, arquivos .md na pasta /docs ) é licenciada pela Creative Commons.

Agradecimentos especiais

BrowserStack nos oferece suporte com acesso gratuito para código aberto.

O Rocket Validator nos ajuda a encontrar problemas de marcação HTML ou acessibilidade.