Skip to main content

​
Comece em três etapas

Coloque seu site de documentação em execução localmente e faça sua primeira personalização.

​
Etapa 1: Configure seu ambiente local

Durante o processo de integração, você criou um repositório GitHub com o conteúdo da sua documentação se ainda não tivesse um. Você pode encontrar um link para este repositório no seu painel.Para clonar o repositório localmente para que você possa fazer e visualizar alterações na sua documentação, siga o guia Clonar um repositório na documentação do GitHub.
  1. Instale o CLI do Mintlify: npm i -g mint
  2. Navegue até o diretório da sua documentação e execute: mint dev
  3. Abra http://localhost:3000 para ver sua documentação ao vivo!
Sua visualização é atualizada automaticamente conforme você edita os arquivos.

​
Etapa 2: Faça deploy das suas alterações

Instale o aplicativo GitHub do Mintlify no seu painel.Nosso aplicativo GitHub faz o deploy automaticamente das suas alterações para o site da sua documentação, então você não precisa gerenciar os deploys manualmente.
Para uma primeira alteração, vamos atualizar o nome e as cores do site da sua documentação.
  1. Abra docs.json no seu editor.
  2. Altere o campo "name" para o nome do seu projeto.
  3. Atualize as "colors" para corresponder à sua marca.
  4. Salve e veja suas alterações instantaneamente em http://localhost:3000.
Tente alterar a cor primária para ver uma diferença imediata!

​
Etapa 3: Coloque no ar

  1. Faça commit e push das suas alterações.
  2. Sua documentação será atualizada e estará no ar em instantes!

​
Próximos passos

Agora que você tem sua documentação em execução, explore estes recursos principais:

Escrever Conteúdo

Aprenda a sintaxe MDX e comece a escrever sua documentação.

Personalizar estilo

Faça sua documentação corresponder perfeitamente à sua marca.

Adicionar exemplos de código

Inclua blocos de código com destaque de sintaxe.

Documentação da API

Gere automaticamente a documentação da API a partir de especificações OpenAPI.
Precisa de ajuda? Veja nossa documentação completa ou participe da nossa comunidade.