Repolode
Enviar
nuxt-content

nuxt-content/docus

Gerador de sites de documentação baseado em Nuxt, que permite escrever a documentação em Markdown com componentes Vue.

Alternativa open source a:GitBookReadMe

Ver no GitHubSite
Estrelas
3,117
Forks
292
Issues abertas
40
Último commit
há 3 dias

O que é?

Docus é um framework de documentação baseado em Nuxt. Com um único comando da CLI, você cria a estrutura de um projeto de documentação, com páginas escritas em Markdown e que podem ser estendidas com componentes Vue usando a sintaxe MDC. O site gerado inclui um tema responsivo com modo escuro, busca no lado do cliente e um template i18n para documentação em vários idiomas.

Além do site estático, Docus oferece recursos voltados a IA. Ele inclui um chat assistente que responde a perguntas com base na documentação, um servidor MCP integrado em /mcp para conectar editores e ferramentas de IA, e a geração automática de llms.txt e llms-full.txt. Skills adicionadas a um diretório skills são disponibilizadas em /.well-known/skills/.

O projeto é um monorepo com a CLI create-docus, a camada Nuxt docus, que fornece o tema, e o site oficial de documentação. Os projetos são construídos com Nuxt 4, Nuxt UI 4 e Tailwind CSS 4, e podem ser implantados a partir de um template do Vercel.

Recursos principais

  • 01Escreva páginas em Markdown e incorpore componentes Vue com a sintaxe MDC.
  • 02Crie a estrutura de um novo projeto de documentação com um único comando npx e, opcionalmente, use um template i18n.
  • 03Busca integrada no lado do cliente, com opção de usar um backend de busca textual completa FTS5.
  • 04Modo escuro, layout responsivo e personalização do tema com Nuxt UI 4 e Tailwind CSS 4.
  • 05Servidor MCP integrado e geração automática de llms.txt para ferramentas de IA.
  • 06Geração de sitemap, robots.txt e imagens Open Graph incluída.

Casos de uso

  • Publicar a documentação de um produto ou biblioteca escrita em Markdown a partir de um repositório Git.
  • Criar um site de documentação em vários idiomas com o template i18n.
  • Disponibilizar a documentação do projeto para assistentes de IA por meio do servidor MCP e dos arquivos llms.txt.
  • Criar um protótipo de site de documentação com Nuxt e ampliá-lo com páginas e componentes personalizados.

Tópicos

#documentation-generator#nuxt#markdown#vue#static-site#i18n#mcp#nuxt-theme

Perguntas frequentes

O que é docus?
Gerador de sites de documentação baseado em Nuxt, que permite escrever a documentação em Markdown com componentes Vue. Docus é um framework de documentação baseado em Nuxt. Com um único comando da CLI, você cria a estrutura de um projeto de documentação, com páginas escritas em Markdown e que podem ser estendidas com componentes Vue usando a sintaxe MDC. O site gerado inclui um tema responsivo com modo escuro, busca no lado do cliente e um template i18n para documentação em vários idiomas.
docus é gratuito? Qual é a licença?
docus é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
docus ainda é mantido?
Manutenção ativa. O último commit de docus foi em 16 de out. de 2026.
Para que posso usar docus?
Publicar a documentação de um produto ou biblioteca escrita em Markdown a partir de um repositório Git. Criar um site de documentação em vários idiomas com o template i18n. Disponibilizar a documentação do projeto para assistentes de IA por meio do servidor MCP e dos arquivos llms.txt. Criar um protótipo de site de documentação com Nuxt e ampliá-lo com páginas e componentes personalizados.
Onde consigo docus?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/nuxt-content/docus

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

Projetos relacionados