Jamdesk Documentation logo

Início rápido: implante em 5 minutos

Crie um site de documentação Jamdesk e implante-o no seu subdomínio. Não exige ferramentas de build. Você precisa de uma conta GitHub e de dois arquivos.

O Jamdesk é um software de documentação que publica um repositório GitHub de Markdown como um site de documentação hospedado. Ele gera automaticamente saídas legíveis por IA: llms.txt, endpoints .md por página e um servidor MCP.

Implante um site de documentação com dois arquivos: docs.json e uma página MDX. Escolha o caminho que corresponde ao seu ponto de partida.

Pré-requisitos

Você vai precisar de:

  • Uma conta no GitHub
  • Um repositório com sua documentação (ou nós criamos um para você)

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

Este é o jeito mais rápido de começar. O template inicial inclui conteúdo de exemplo, uma especificação OpenAPI e exemplos de todos os componentes. Veja como as coisas funcionam e depois substitua-os pelo seu próprio conteúdo.

1
Crie uma conta Jamdesk

Acesse dashboard.jamdesk.com e cadastre-se com o GitHub.

2
Crie um projeto a partir de um template

Clique em New Project → From Template → Starter Docs.

O Jamdesk cria para você um repositório no GitHub com tudo já configurado.

3
Está no ar

Sua documentação é implantada em your-project.jamdesk.app. Edite os arquivos MDX e faça push. O site é reconstruído automaticamente.

Você também pode clonar o template inicial diretamente: git clone https://github.com/jamdesk/starter-docs.git my-docs

Quer manter algumas páginas privadas? Adicione private: true ao frontmatter de qualquer arquivo MDX. Defina uma senha em Project Settings após o próximo build. Consulte Controle de acesso para ver as quatro opções (pública, senha para o site inteiro, mista, SSO).

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

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

1
Crie uma conta Jamdesk

Acesse dashboard.jamdesk.com e cadastre-se com o GitHub.

2
Crie um projeto

Clique em New Project e conecte seu repositório.

  1. Selecione seu repositório do GitHub
  2. Escolha a branch que será implantada
  3. O Jamdesk detecta seu docs.json automaticamente

Se o seu repositório ainda não tiver docs.json, adicione o arquivo mínimo descrito em O que há em um projeto de documentação antes de conectá-lo.

Para permissões do repositório, seleção de branch e caminhos da documentação, consulte Conectar GitHub.

3
Está no ar

Sua documentação é implantada em your-project.jamdesk.app. O Jamdesk gera automaticamente o llms.txt para ferramentas de IA.

Cada push para a branch conectada dispara uma reconstrução automática.

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 cobre o comando jamdesk migrate para o Mintlify e os passos manuais para outras ferramentas de documentação. Depois, conecte o repositório migrado usando a Opção 2.

Guia de migração

Converta documentação do Mintlify ou migre manualmente de outra plataforma de documentação

O que há em um projeto de docs

Um projeto mínimo do Jamdesk tem duas coisas:

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

Para sites maiores, consulte Estrutura de diretórios para ver as pastas recomendadas, recursos e snippets.

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 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 Fundamentos de MDX para frontmatter, cabeçalhos, links e sintaxe de componentes.

Desenvolvimento local

Visualize as alterações localmente com a CLI do Jamdesk antes de fazer push para o GitHub. Ela detecta erros de sintaxe MDX antes que cheguem ao seu site publicado. Consulte a visão geral da CLI do Jamdesk para todos os métodos de instalação e comandos.

Execute:

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...
  1. Adicione-o ao docs.json:
docs.json
{
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction", "getting-started"]
      }
    ]
  }
}
  1. Faça push para o GitHub. Sua nova página é implantada automaticamente.

Para 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. Digite 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?

Consulte a Central de ajuda para guias de configuração, faturamento e solução de problemas. Para falar 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

As referências cobrem todos os componentes MDX, todos os comandos da CLI e todas as opções de configuração do docs.json.

O que vem a seguir?

Tutorial completo

Fluxo completo desde a configuração até o domínio personalizado

Fundamentos de MDX

Escreva documentação em MDX

Componentes

Explore os componentes disponíveis

Referência de configuração

Todas as opções do docs.json