Documentação do Jamdesk
Crie documentação pronta para IA com o Jamdesk, baseada em MDX e GitHub. Publique em segundos com busca, análises 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 tarefas de DevOps. Cada site gera um arquivo llms.txt para que ferramentas de IA possam indexar seu conteúdo.
Escreva com IA. Use Cursor, Claude ou qualquer assistente de IA para gerar e editar sua documentação. MDX é um formato de texto que as ferramentas de IA entendem nativamente, portanto não são necessários prompts especiais.
Um projeto Jamdesk mínimo
my-docs/
├── docs.json
└── introduction.mdxIsso é tudo de que você precisa. Consulte o Guia de início rápido para criar o seu.
Consulte no GitHub o código-fonte desta documentação. É um projeto Jamdesk funcional que você pode usar como referência.
O que está incluído
Precisa de documentação privada? Proteja todo o site com uma senha, restrinja páginas individuais com private: true ou use SSO no Enterprise. Consulte o Controle de acesso.
Como funciona
Crie documentação usando Markdown com componentes React opcionais. Use seu editor favorito: VS Code, Cursor ou qualquer editor de texto simples. Ferramentas de IA, como Claude, podem gerar e editar MDX nativamente.
Faça commit das suas alterações e envie-as. Você não precisa executar um comando de build nem manter um script de publicação.
O Jamdesk detecta seu envio, cria seu site e o publica em uma CDN global. Sua documentação estará disponível em your-project.jamdesk.app.
O que você pode criar
Guias do usuário, documentação de recursos e centrais de ajuda. Uma navegação clara ajuda os usuários a encontrar respostas rapidamente. Ver componentes →