Jamdesk Documentation logo

Documentação Jamdesk

Crie documentação pronta para IA com o Jamdesk, uma ferramenta de documentação de software baseada em MDX e GitHub. Publique em segundos com busca, análise e temas integrados.

O Jamdesk é uma ferramenta de documentação de software que cria sites de documentação a partir dos seus arquivos Markdown. Conecte um repositório do GitHub, escreva em MDX e publique globalmente em segundos. Você não precisa configurar um pipeline de build nem executar nenhuma tarefa de DevOps. Cada site gera um arquivo llms.txt, que as ferramentas de IA usam para indexar o seu conteúdo.

Escreva com IA. Use o Cursor, o Claude ou qualquer assistente de IA para gerar e editar sua documentação. As ferramentas de IA leem MDX nativamente. Você não precisa de prompts especiais.

Um projeto Jamdesk mínimo

my-docs/
├── docs.json
└── introduction.mdx

É só isso que você precisa. Veja o Início rápido para criar o seu.

Navegue pelo código-fonte desta documentação no GitHub. É um projeto Jamdesk funcional que você pode usar como referência.

O que está incluído

Publique em segundos

Envie para o GitHub. Sua documentação é publicada em uma CDN global. Sem configurações de build nem pipelines de CI.

Escreva em MDX

Markdown padrão com componentes React para elementos interativos.

Temas e identidade visual

Escolha entre Jam, Nebula ou Pulsar e depois ajuste cores, fontes e estilos para combinar com a sua marca.

Busca integrada

Busca com Cmd+K que indexa o seu conteúdo automaticamente.

Precisa de documentação privada? Proteja todo o site com uma senha, restrinja páginas individuais com private: true ou use SSO no plano Enterprise. Veja Controle de acesso.

Como funciona

1
Escreva em MDX

Crie a documentação usando Markdown com componentes React opcionais. Use o seu editor favorito: VS Code, Cursor ou qualquer editor de texto simples. Ferramentas de IA como o Claude podem gerar e editar MDX nativamente.

2
Envie para o GitHub

Faça o commit das suas alterações e envie. Você não precisa executar nenhum comando de build nem manter um script de deploy.

3
Publicado em segundos

O Jamdesk detecta o seu envio, gera o seu site e o publica em uma CDN global. Sua documentação fica disponível em your-project.jamdesk.app.

O que você pode criar

Guias do usuário, documentação de funcionalidades e centros de ajuda. A navegação clara ajuda os leitores a encontrar respostas. Veja os componentes →

Mais recursos

Chat com IA

O assistente de chat integrado responde às perguntas dos visitantes com base na sua documentação.

Integração MCP

Agentes de IA consultam a sua documentação pelo Model Context Protocol.

Análise integrada

Visualizações de página, buscas e dados geográficos sem ferramentas de terceiros.

Suporte a OpenAPI

Gere páginas de API automaticamente a partir da sua especificação OpenAPI 3.0+.

Domínios personalizados

Publique em docs.suaempresa.com com SSL automático.

Pronto para SEO

Meta tags, imagens Open Graph e sitemaps gerados automaticamente.

Comece agora

Início rápido

Publique seu primeiro site de documentação em 5 minutos

Guia da CLI

Configure o desenvolvimento local

Fundamentos de MDX

Aprenda a escrever documentação

Componentes

Explore os componentes disponíveis