Repolode
Enviar
cloudflare

cloudflare/nimbus

Um scaffolder que gera no seu repositório um site de documentação Astro editável, com Markdown legível por agentes e saída llms.txt incluídos.

Ver no GitHub
Estrelas
1,431
Forks
52
Issues abertas
9
Último commit
ontem

O que é?

Nimbus cria no seu repositório um site de documentação Astro completo, com arquivos-fonte reais para layouts, componentes, estilos, rotas e conteúdo. A infraestrutura subjacente é distribuída como um pacote npm, enquanto tudo o que você vê e modifica fica na sua própria base de código desde o primeiro commit.

Ele foi feito tanto para leitores humanos quanto para agentes de programação. Cada página que pode ser descoberta está disponível em Markdown limpo e como fonte MDX, e o site publica /llms.txt, /llms-full.txt, JSON-LD, um sitemap e imagens OG por página. Busca em texto completo, temas claro e escuro, breadcrumbs, paginação e documentação versionada estão incluídos, além de linting para prosa e MDX.

A saída padrão é estática e pode ser hospedada em qualquer lugar. Cloudflare é o destino prioritário, com um modo de saída renderizado no servidor e um wrangler.jsonc no scaffold padrão. Componentes opcionais e receitas para transferir tarefas a agentes podem ser adicionados a partir de um registry. O projeto ainda está antes da versão 1.0, e sua API pública pode mudar entre versões minor.

Recursos principais

  • 01Cria um site de documentação Astro com layouts, componentes, estilos e conteúdo editáveis.
  • 02Publica versões em Markdown e MDX de cada página para agentes.
  • 03Gera llms.txt, llms-full.txt, JSON-LD, sitemap e imagens OG.
  • 04Inclui busca em texto completo, temas claro e escuro e documentação versionada.
  • 05Oferece linting de prosa e MDX, além de validação de configuração.
  • 06Oferece suporte a saída estática e renderização no servidor na Cloudflare.

Casos de uso

  • Criar um site de documentação de produto que você queira personalizar diretamente nos arquivos.
  • Publicar documentação que agentes de programação consigam ler com a mesma facilidade que navegadores.
  • Hospedar na Cloudflare um site de documentação versionado.

Início rápido

  1. 1

    Criar a estrutura de um novo site de documentação

    npx @cloudflare/create-nimbus-docs@latest my-docs
  2. 2

    Entrar na pasta do projeto

    cd my-docs
  3. 3

    Instalar as dependências

    pnpm install
  4. 4

    Iniciar o servidor de desenvolvimento

    pnpm dev

Antes de usar

  • O projeto ainda está antes da versão 1.0, então sua API pública pode mudar entre versões menores.
  • Contribuições só são aceitas por meio de issues e discussões aprovadas previamente por um mantenedor.

Tópicos

#astro#documentation#static-site#llms-txt#markdown#mdx#cloudflare#typescript

Perguntas frequentes

O que é nimbus?
Um scaffolder que gera no seu repositório um site de documentação Astro editável, com Markdown legível por agentes e saída llms.txt incluídos. Nimbus cria no seu repositório um site de documentação Astro completo, com arquivos-fonte reais para layouts, componentes, estilos, rotas e conteúdo. A infraestrutura subjacente é distribuída como um pacote npm, enquanto tudo o que você vê e modifica fica na sua própria base de código desde o primeiro commit.
nimbus é gratuito? Qual é a licença?
nimbus é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
nimbus ainda é mantido?
Manutenção ativa. O último commit de nimbus foi em 19 de out. de 2026.
Para que posso usar nimbus?
Criar um site de documentação de produto que você queira personalizar diretamente nos arquivos. Publicar documentação que agentes de programação consigam ler com a mesma facilidade que navegadores. Hospedar na Cloudflare um site de documentação versionado.
Como instalar nimbus?
Criar a estrutura de um novo site de documentação: npx @cloudflare/create-nimbus-docs@latest my-docs Entrar na pasta do projeto: cd my-docs Instalar as dependências: pnpm install Iniciar o servidor de desenvolvimento: pnpm dev
Onde consigo nimbus?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/cloudflare/nimbus

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados