Saltar para o conteúdo principal
50% de desconto todos os planos, tempo limitado. A partir de $2.48/mo
Docusaurus

Docusaurus

O Docusaurus é o gerador de sites de documentação da Meta. Ele oferece docs versionados, busca, traduções e um tema React que você pode sobrescrever página a página. Licença MIT e mais de 65.900 estrelas no GitHub.

Em resumo

66k

Estrelas no GitHub

1

Visualizações de página

Licença MIT Versão 3.10.2 OS Ubuntu Server 24.04 LTS Min RAM 1 GB IP IPV6,IPV4

Acesso

  • Abra o Docusaurus: http://<SERVER_IP>

Editar e publicar conteúdo

1. Adicione ou edite arquivos de conteúdo:

/opt/docusaurus/docs
/opt/docusaurus/blog
/opt/docusaurus/src/pages

2. Atualizar /opt/docusaurus/docusaurus.config.js para as configurações do site, a navegação e a configuração do tema.

3. Reconstrua o site:

cd /opt/docusaurus && npm run build

O Nginx serve os arquivos gerados de: /opt/docusaurus/build

Não é necessário reiniciar o Nginx após reconstruir.

Caminhos importantes

  • Projeto: /opt/docusaurus
  • Documentação: /opt/docusaurus/docs
  • Blog: /opt/docusaurus/blog
  • Páginas: /opt/docusaurus/src/pages
  • Configuração: /opt/docusaurus/docusaurus.config.js
  • Saída do build: /opt/docusaurus/build
  • Configuração do Nginx: /etc/nginx/sites-available/docusaurus.conf

Domínio e HTTPS

1. Aponte seu domínio para o endereço IP do servidor.

2. Edite a configuração do Nginx e substitua server_name _; pelo seu domínio (por exemplo, server_name <YOUR_DOMAIN>;):

vim /etc/nginx/sites-available/docusaurus.conf

3. Teste a configuração:

nginx -t

4. Instale o Certbot:

apt install -y certbot python3-certbot-nginx

5. Gere um certificado Let's Encrypt:

certbot --nginx --non-interactive --agree-tos --email <YOUR_EMAIL> -d <YOUR_DOMAIN>

6. Recarregue o Nginx:

systemctl reload nginx

7. Atualize a URL do site Docusaurus: substitua url: 'http://<SERVER_IP>', por url: 'https://<YOUR_DOMAIN>', in /opt/docusaurus/docusaurus.config.js.

8. Reconstrua o site:

cd /opt/docusaurus && npm run build

9. Abra o seu browser e visite: https://<YOUR_DOMAIN>

Notas

  • O Docusaurus gera um site estático, sem necessidade de banco de dados.
  • Mudanças de conteúdo exigem um novo build antes de aparecerem publicamente.
  • Altere a configuração do Docusaurus e a estrutura do projeto conforme suas preferências.

Mais em Ferramentas de desenvolvimento

Aplicações relacionadas.

Implante Docusaurus agora. A partir de $2,48/mês.