Repolode
Enviar
docmd-io

docmd-io/docmd

Um compilador de documentação Markdown que transforma uma pasta de origem em um site estático, busca offline, llms.txt e contexto para agentes de IA.

Alternativa open source a:DocusaurusMintlify

Ver no GitHubSite
Estrelas
2,528
Forks
144
Issues abertas
2
Último commit
há 3 dias

O que é?

docmd é um compilador de documentação feito com Node.js. Basta indicar uma pasta com arquivos Markdown para gerar um site estático navegável, com a navegação derivada da estrutura de arquivos — sem precisar de arquivo de configuração nem frontmatter para começar. Uma única compilação também gera um índice de busca offline, sitemap, metadados de SEO e Open Graph, além de robots.txt.

O mesmo conteúdo de origem também pode gerar formatos legíveis por máquinas. docmd cria llms.txt e llms-full.txt, pacotes no formato Open Knowledge para sistemas RAG e um servidor MCP que permite a agentes de programação buscar, ler e validar a documentação. Um plugin opcional de AI Assistant oferece chat com RAG sobre a documentação, usando seu próprio provedor ou o Cloud Relay hospedado.

O projeto oferece suporte a internacionalização, versionamento, workspaces de monorepo, renderização de OpenAPI 3.x, diagramas Mermaid e um sistema de plugins. Também inclui um comando de migração para projetos que vêm do Docusaurus, VitePress, MkDocs ou Starlight. O resultado pode ser publicado em qualquer host estático, e o compilador e os plugins principais usam a licença MIT.

Recursos principais

  • 01Gera um site estático de documentação com navegação baseada na estrutura de arquivos
  • 02Busca offline em texto completo, sitemap, URLs canônicas e metadados Open Graph
  • 03Gera llms.txt, llms-full.txt e pacotes no formato Open Knowledge
  • 04Servidor MCP para agentes de programação buscarem, lerem e validarem a documentação
  • 05Internacionalização, versionamento e workspaces de monorepo
  • 06Renderização de OpenAPI 3.x e suporte a diagramas Mermaid

Casos de uso

  • Publicar a documentação de um projeto a partir de uma pasta Markdown existente, sem configuração
  • Fornecer contexto estruturado da documentação para LLMs e agentes de programação
  • Migrar um site existente de Docusaurus, VitePress ou MkDocs
  • Hospedar documentação de API multilíngue em qualquer host estático

Início rápido

  1. 1

    Aponte o docmd para uma pasta Markdown e inicie o servidor de desenvolvimento

    npx @docmd/core dev
  2. 2

    Gere um site estático para implantação

    npx @docmd/core build

Antes de usar

  • Requer Node.js 20 ou superior.
  • Recursos opcionais, como o AI Assistant, exigem uma chave própria de um provedor de IA ou o Cloud Relay; o uso de modelos pode ser cobrado à parte.

Tópicos

#documentation#markdown#static-site-generator#llms-txt#mcp#openapi#i18n#typescript#ai-skills#api

Perguntas frequentes

O que é docmd?
Um compilador de documentação Markdown que transforma uma pasta de origem em um site estático, busca offline, llms.txt e contexto para agentes de IA. docmd é um compilador de documentação feito com Node.js. Basta indicar uma pasta com arquivos Markdown para gerar um site estático navegável, com a navegação derivada da estrutura de arquivos — sem precisar de arquivo de configuração nem frontmatter para começar. Uma única compilação também gera um índice de busca offline, sitemap, metadados de SEO e Open Graph, além de robots.txt.
docmd é gratuito? Qual é a licença?
docmd é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
docmd ainda é mantido?
Manutenção ativa. O último commit de docmd foi em 16 de out. de 2026.
Para que posso usar docmd?
Publicar a documentação de um projeto a partir de uma pasta Markdown existente, sem configuração Fornecer contexto estruturado da documentação para LLMs e agentes de programação Migrar um site existente de Docusaurus, VitePress ou MkDocs Hospedar documentação de API multilíngue em qualquer host estático
Como instalar docmd?
Aponte o docmd para uma pasta Markdown e inicie o servidor de desenvolvimento: npx @docmd/core dev Gere um site estático para implantação: npx @docmd/core build
Onde consigo docmd?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/docmd-io/docmd

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

Projetos relacionados