Como Hospedar uma documentação que usa Docusaurus na Discloud?

O Docusaurus é um gerador de sites estáticos excelente para documentação técnica. Ele é mantido pelo time do Facebook e é altamente personalizável, usando React, Markdown e TypeScript.

Se você quer colocar sua documentação no ar de forma rápida e barata, a Discloud pode ser uma excelente alternativa gratuita para projetos pequenos.

Neste artigo, vamos mostrar como subir sua documentação Docusaurus na Discloud, passo a passo.

1. Criando o Projeto Docusaurus

Se você ainda não criou seu projeto Docusaurus, use o comando abaixo. No lugar de my-docs, coloque o nome que quiser pro seu projeto:

npx create-docusaurus@latest my-docs classic
cd my-docs

Se já tiver criado o projeto, pode pular direto para o passo 2!

2. Trocando de JavaScript para TypeScript

Renomeie o arquivo docusaurus.config.js para docusaurus.config.ts.

Como o Docusaurus é todo escrito em TypeScript, essa mudança ajuda a Discloud a identificar que seu projeto irá usar TS.

3. Ajustando o package.json

Abra o arquivo package.json e edite a seção "scripts" assim:

"scripts": {
  "build": "docusaurus build --out-dir dist",
  "serve": "docusaurus serve --dir dist"
}

Com essa mudança, o site sempre será buildado e servido a partir da pasta dist, e seu package.json ficará parecido com isso aqui:

"scripts": {
  "docusaurus": "docusaurus",
  "start": "docusaurus start",
  "build": "docusaurus build --out-dir dist",
  "swizzle": "docusaurus swizzle",
  "deploy": "docusaurus deploy",
  "clear": "docusaurus clear",
  "serve": "docusaurus serve --dir dist",
  "write-translations": "docusaurus write-translations",
  "write-heading-ids": "docusaurus write-heading-ids"
}

4. Configurando o discloud.config

Crie um arquivo chamado discloud.config na raiz do seu projeto com o seguinte conteúdo:

NAME=MeuSite
AVATAR=https://i.imgur.com/bWhx7OT.png
ID=subdomain
TYPE=site
MAIN=docusaurus.config.ts
RAM=512
AUTORESTART=false
VERSION=latest
APT=tools
START=npm run serve -- --port 8080 --host 0.0.0.0 --dir dist

Para as configurações MAIN e START, precisa ser assim. É possível modificar conforme o seu ID, nome, entre outros parâmetros.

5. Faça o upload para a Discloud

Com tudo configurado certinho, é hora de enviar seu projeto para a Discloud e colocá-lo no ar!

Não vou detalhar o passo a passo do upload aqui, mas a Discloud oferece uma documentação completa que explica tudo o que você precisa para realizar o deploy. Vale a pena conferir o guia da Discloud .

Depois disso, seu site estará online e acessível para todo mundo!