Início rápido: deploy em 5 min

O Jamdesk é um software de documentação que publica um repositório GitHub de Markdown como um site de documentação hospedado, com saída legível por IA (llms.txt, endpoints .md por página e um servidor MCP) gerada automaticamente.

Faça o deploy de um site de documentação usando apenas dois arquivos: docs.json e uma página MDX. Escolha o caminho que corresponde ao seu ponto de partida.

Pré-requisitos

Você precisará de:

• Uma conta do GitHub
• Um repositório com sua documentação (ou criaremos um para você)

Opção 1: começar pelo template inicial

A maneira mais rápida de começar. O template inicial inclui conteúdo de exemplo, uma especificação OpenAPI e exemplos de todos os componentes, para que você veja como tudo funciona antes de substituí-los pelo seu próprio conteúdo.

Opção 2: conectar um repositório existente

Já tem um repositório com documentação pronta para o Jamdesk? Conecte-o diretamente. Se estiver migrando do Mintlify ou de outra plataforma de documentação, use a Opção 3 primeiro.

Opção 3: migrar do Mintlify ou de outra plataforma

Já tem documentação no Mintlify, GitBook, Docusaurus, ReadMe, Confluence ou outra plataforma? Comece pelo guia de migração antes de criar um novo projeto. Ele aborda o comando jamdesk migrate para o Mintlify e as etapas manuais para outras ferramentas de documentação. Após a migração, conecte o repositório migrado usando a Opção 2.

O que há em um projeto de docs

Um projeto Jamdesk mínimo tem dois elementos:

my-docs/
├── docs.json           # Configuration
└── introduction.mdx    # Your first page

Para sites maiores, consulte Estrutura de diretórios para ver pastas, assets e snippets recomendados.

docs.json

O arquivo de configuração que define seu site:

{
  "$schema": "https://jamdesk.com/docs.json",
  "name": "My Docs",
  "theme": "jam",
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction"]
      }
    ]
  }
}

Consulte a Referência do docs.json para ver todas as opções de configuração.

Páginas MDX

Páginas de documentação escritas em MDX:

---
title: Introduction
description: Welcome to the docs
---

# Welcome

This is your first documentation page.

Consulte Noções básicas de MDX para saber mais sobre frontmatter, títulos, links e sintaxe de componentes.

Desenvolvimento local

A CLI do Jamdesk permite visualizar alterações localmente antes de fazer push para o GitHub. Isso ajuda a identificar erros de sintaxe MDX antes que eles cheguem ao seu site publicado. Para consultar todos os métodos de instalação e comandos, veja a visão geral da CLI do Jamdesk.

Visualize as alterações localmente:

npm install -g jamdesk
cd my-docs
jamdesk dev

Abra http://localhost:3000 para ver sua documentação com hot reload.

Adicionar mais páginas

1. Crie um novo arquivo MDX:

---
title: Getting Started
description: Learn the basics
---

Your content here...

2. Adicione-o ao docs.json:

{
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction", "getting-started"]
      }
    ]
  }
}

3. Faça push para o GitHub: sua nova página será publicada automaticamente.

Para ver mais padrões de links, incluindo âncoras e cards, consulte Links e navegação.

Domínio personalizado

Adicione seu próprio domínio em Settings → Domains:

1. Insira seu domínio (por exemplo, docs.example.com)
2. Adicione os registros DNS exibidos
3. Aguarde a verificação (até 48 horas)

Os certificados SSL são provisionados automaticamente. Guia completo →

Precisa de ajuda?

Está com algum problema? Consulte a Central de ajuda para ver guias de configuração, cobrança e solução de problemas. Ou fale com uma pessoa: abra o widget de chat no canto inferior de qualquer página do Jamdesk ou envie um e-mail para support@jamdesk.com. Respondemos rapidamente.

Referência completa

Tudo o que você pode criar e executar está em três referências: cada componente MDX, cada comando da CLI e cada opção de configuração do docs.json.

O que vem a seguir?