O Docusaurus transforma sua documentação num site estático em build/: cada documento e cada post do blog em HTML, com busca e navegação que rodam no navegador. O Lobsite hospeda essa pasta. Rode npm run build, depois npx lobsite, e sua documentação fica no ar num endereço *.lobsite.app com HTTPS. Cada deploy ganha também uma URL própria, útil para revisar mudanças na documentação antes de irem ao ar.
Como funciona
- Faça o build da documentação com
npm run build. O Docusaurus escreve o site embuild/e, por padrão, falha o build se houver links quebrados. - Rode
npx lobsiteno projeto. Ele publicabuild/, nãostatic/. O primeiro deploy não precisa de conta e dura 6 horas. - Mantenha-a com o link de resgate, numa conta gratuita. Depois disso,
npm run build && npx lobsiteatualiza o mesmo endereço.
url, baseUrl e barras finais
// docusaurus.config.js
export default {
url: "https://my-docs.lobsite.app",
baseUrl: "/",
};
urlé o endereço do seu site. O Docusaurus o usa para links canônicos e o sitemap.baseUrlé/no Lobsite. Um site de projeto do GitHub Pages usa/repo-name/; deixar isso quebra todos os links de assets.trailingSlashpode ficar de fora. Documentos gerados comodocs/intro/index.htmlabrem em/docs/intro/;/docs/introredireciona para lá.
Revisando mudanças na documentação
A documentação é escrita por muita gente e muitas vezes revisada por outra pessoa. lobsite deploy --preview publica o build numa URL própria sem mexer na documentação no ar, então quem revisa lê a mudança como ela vai ficar. lobsite promote coloca no ar, e lobsite rollback volta para a versão anterior num passo só. Vai mover páginas? Adicione redirecionamentos dos caminhos antigos no lobsite.toml para que links de resultados de busca e de outros sites continuem funcionando; o Gerador de redirecionamentos escreve as regras. Agentes de programação com IA podem rodar o mesmo deploy com npx -y lobsite --yes, que nunca para para fazer perguntas.
Veja a prévia antes de ir ao ar. Volte atrás com um clique, redirecionamentos inclusos.
Os arquivos são guardados pelo hash. Refazer o deploy de um site sem mudanças envia 0 bytes.
Todo site ganha um endereço *.lobsite.app com HTTPS desde o primeiro deploy.
Redirecionamentos, cabeçalhos e formulários ficam no lobsite.toml e acompanham cada deploy.
Nenhuma pergunta quando roda sob um agente, e uma linha Tell the user: com a URL e o link de resgate.
Todo limite é publicado, e todo erro diz o que fazer em seguida.
Hospedagens para Docusaurus comparadas
| Lobsite | GitHub Pages | Netlify | Vercel | |
|---|---|---|---|---|
| Faz o build da documentação por você | Não: você publica build/ |
No GitHub Actions, ou docusaurus deploy |
Sim | Sim |
| URL de prévia para cada deploy | Sim | Não | Sim | Sim |
| Rollback num passo | Sim | Reverter um commit | Sim | Sim |
| Conta antes do primeiro deploy | Não: no ar por 6 horas, depois mantenha grátis | Sim, e um repositório | Sim | Sim |
| Domínio próprio | Sim, grátis | Sim, grátis | Sim | Sim |
O GitHub Pages funciona bem para documentação open source que fica ao lado do código. O Lobsite serve para documentação que você gera localmente ou no CI e quer pré-visualizar, publicar e reverter sem um fluxo de Git em volta da hospedagem.
Perguntas frequentes
Qual baseUrl o Docusaurus deve usar no Lobsite?
/. O site é servido a partir da raiz do endereço. Só um site de projeto do GitHub Pages precisa de /repo-name/.
A busca do Docusaurus funciona numa hospedagem estática?
Sim. O Algolia DocSearch roda no navegador do visitante, e plugins de busca local geram o índice dentro de build/. Nenhum dos dois precisa de servidor.
Posso hospedar documentação versionada do Docusaurus?
Sim. Cada versão é gerada em build/ como páginas próprias, então todas são publicadas juntas. Só os arquivos alterados desde o último deploy são enviados.
Qual o tamanho máximo de um site Docusaurus?
No plano gratuito, até 100 arquivos e 50 MB por deploy, o que cabe na maioria dos sites de documentação. Documentações maiores, com muitas versões ou imagens, precisam do plano pago, em breve; todos os limites estão na tabela de limites.