---
title: Documentação do Jamdesk
sidebarTitle: Introdução
description: Crie documentação pronta para IA com o Jamdesk, baseada em MDX e GitHub. Publique em segundos com busca, análises e temas integrados.
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

<YouTube id="7sYbBOdbS2I" />

O Jamdesk é uma [ferramenta de documentação de software](https://jamdesk.com) 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.

<Info>
**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.
</Info>

## Um projeto Jamdesk mínimo

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

Isso é tudo de que você precisa. Consulte o [Guia de início rápido](/pt/quickstart) para criar o seu.

<Tip>
Consulte no GitHub o [código-fonte desta documentação](https://github.com/jamdesk/jamdesk-docs). É um projeto Jamdesk funcional que você pode usar como referência.
</Tip>

## O que está incluído

<Columns cols={2}>
  <Card title="Publique em segundos" icon="rocket" href="/pt/how-jamdesk-works">
    Envie para o GitHub e sua documentação será publicada em uma CDN global. Sem configurações de build nem pipelines de CI.
  </Card>
  <Card title="Escreva em MDX" icon="file-code" href="/pt/content/mdx-basics">
    Markdown padrão com componentes React para elementos interativos.
  </Card>
  <Card title="Temas e marca" icon="paintbrush" href="/pt/customization/theming">
    Escolha entre Jam, Nebula ou Pulsar e substitua cores, fontes e estilos para combinar com sua marca.
  </Card>
  <Card title="Busca integrada" icon="magnifying-glass" href="/pt/setup/search-analytics">
    Busca com Cmd+K que indexa seu conteúdo automaticamente.
  </Card>
</Columns>

<Tip>
**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](/pt/setup/access-control).
</Tip>

## Como funciona

<Steps>
  <Step title="Escreva em MDX">
    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.
  </Step>
  <Step title="Envie para o GitHub">
    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.
  </Step>
  <Step title="Online em segundos">
    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`.
  </Step>
</Steps>

## O que você pode criar

<Tabs>
  <Tab title="Documentação de produto">
    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 →](/pt/components/overview)
  </Tab>
  <Tab title="Referência de API">
    Documentação de endpoints com exemplos de código com realce de sintaxe, exemplos de requisições e respostas e guias de autenticação. [Ver suporte a OpenAPI →](/pt/api-reference/openapi-example)
  </Tab>
  <Tab title="Guias para desenvolvedores">
    Tutoriais, guias de início rápido e guias de integração. Componentes passo a passo tornam procedimentos complexos mais fáceis de entender. [Ver um exemplo →](/pt/end-to-end-tutorial)
  </Tab>
</Tabs>

## Mais recursos

<Columns cols={2}>
  <Card title="Chat de IA" icon="comment" href="/pt/ai/chat">
    O assistente de chat integrado responde às perguntas dos visitantes usando sua documentação.
  </Card>
  <Card title="Integração com MCP" icon="plug-circle-bolt" href="/pt/ai/mcp-server">
    Agentes de IA consultam sua documentação por meio do Model Context Protocol.
  </Card>
  <Card title="Análises integradas" icon="chart-line" href="/pt/setup/analytics-overview">
    Visualizações de páginas, consultas de busca e dados geográficos sem ferramentas de terceiros.
  </Card>
  <Card title="Suporte a OpenAPI" icon="plug" href="/pt/api-reference/openapi-example">
    Gere automaticamente páginas de API a partir da sua especificação OpenAPI 3.0 ou posterior.
  </Card>
  <Card title="Domínios personalizados" icon="globe" href="/pt/deploy/custom-domains">
    Publique em `docs.yourcompany.com` com SSL automático.
  </Card>
  <Card title="Pronto para SEO" icon="magnifying-glass-chart" href="/pt/content/seo">
    Meta tags, imagens Open Graph e sitemaps gerados automaticamente.
  </Card>
</Columns>

## Comece agora

<Columns cols={2}>
  <Card title="Guia de início rápido" icon="play" href="/pt/quickstart">
    Publique seu primeiro site de documentação em 5 minutos
  </Card>
  <Card title="Guia da CLI" icon="terminal" href="/pt/cli/overview">
    Configure o desenvolvimento local
  </Card>
  <Card title="Fundamentos de MDX" icon="file-lines" href="/pt/content/mdx-basics">
    Aprenda a escrever documentação
  </Card>
  <Card title="Componentes" icon="puzzle-piece" href="/pt/components/overview">
    Explore os componentes disponíveis
  </Card>
</Columns>