Este guia rápido mostra como configurar e implantar seu site de documentação em poucos minutos. Ao concluir este guia, você terá um site de documentação no ar, pronto para personalizar e expandir.
Pré-requisitos: Antes de começar, crie uma conta e conclua a etapa inicial de onboarding.

​
Primeiros passos

Após concluir o processo de onboarding, seu site de documentação é implantado automaticamente em uma URL exclusiva neste formato: 
https://<your-project-name>.mintlify.app
Encontre sua URL na página Overview do seu dashboard.
Domínio Mintlify
A URL do seu site fica disponível imediatamente. Use essa URL para testes e para compartilhar com sua equipe enquanto configura seu site de documentação.

​
Instale o GitHub App

A Mintlify oferece um GitHub App que automatiza a implantação quando você envia alterações para o seu repositório. Instale o GitHub App seguindo as instruções da checklist de onboarding ou do seu painel.
  1. Acesse Settings no seu painel da Mintlify.
  2. Selecione GitHub App na barra lateral.
  3. Clique em Install GitHub App. Uma nova aba será aberta com a página de instalação do GitHub App.
  4. Selecione a organização ou conta de usuário onde você deseja instalar o app.
  5. Selecione os repositórios que você deseja conectar.
Instalação do GitHub App
Atualize as permissões do GitHub App se você mover sua documentação para outro repositório.

​
Autorize sua conta do GitHub

  1. Acesse Settings no painel do Mintlify.
  2. Selecione My Profile na barra lateral.
  3. Selecione Authorize GitHub account. Isso abrirá uma nova guia com a página de autorização do GitHub.
Um administrador da sua organização no GitHub pode precisar autorizar sua conta, dependendo das configurações da organização.

​
Fluxos de edição

A Mintlify oferece dois fluxos de trabalho para criar e manter sua documentação:

Fluxo baseado em código

Para usuários que preferem trabalhar com ferramentas existentes em seu ambiente local. Clique para ir diretamente a esta seção.

Fluxo com o Editor web

Para usuários que preferem uma interface visual no navegador. Clique para ir diretamente a esta seção.

​
Fluxo de trabalho baseado em código

O fluxo de trabalho baseado em código integra-se ao seu ambiente de desenvolvimento e aos repositórios Git existentes. Esse fluxo é ideal para equipes técnicas que desejam gerenciar a documentação junto com o código.

​
Instale a CLI

Para trabalhar localmente com sua documentação, instale a interface de linha de comando (CLI), chamada mint, executando este comando no terminal: 
npm i -g mint
É necessário ter o Node.js instalado na máquina. Se você tiver problemas na instalação, consulte o guia de solução de problemas.

​
Edite a documentação

Depois de configurar seu ambiente, você pode começar a editar os arquivos da documentação. Por exemplo, atualize o título da página de introdução:
  1. Abra o repositório criado durante o onboarding.
  2. Abra index.mdx e localize o início do arquivo:
index.mdx
---
title: "Introduction"
description: "This is the introduction to the documentation"
---
  1. Atualize o campo title para "Hello World".
index.mdx
---
title: "Hello World"
description: "This is the introduction to the documentation"
---

​
Visualize as alterações

Para visualizar as alterações localmente, execute o seguinte comando: 
mint dev
A visualização estará disponível em localhost:3000.
Mintlify Dev

​
Enviar as alterações

Quando estiver pronto para publicar suas alterações, envie-as para o repositório. A Mintlify detecta automaticamente as alterações, compila a documentação e implanta as atualizações no site. Monitore o status da implantação no histórico de commits do repositório no GitHub ou no dashboard. Após a conclusão da implantação, a atualização mais recente estará disponível em <your-project-name>.mintlify.app.

Ir para a adição de um domínio personalizado

Opcionalmente, pule o fluxo de trabalho do Editor web e vá direto para adicionar um domínio personalizado.

​
Fluxo de trabalho do Editor web

O fluxo de trabalho do Editor web oferece uma interface WYSIWYG (what you see is what you get — o que você vê é o que obtém) para criar e editar documentação. Esse fluxo é ideal para quem prefere trabalhar no navegador, sem ferramentas adicionais de desenvolvimento local.

​
Acesse o editor web

  1. Entre no seu dashboard.
  2. Selecione Editor na barra lateral esquerda.
Se você ainda não instalou o GitHub App, será solicitado a instalá-lo ao abrir o editor web.
O editor web da Mintlify no modo editor visual

​
Edite a documentação

No Editor web, você pode navegar pelos arquivos da sua documentação na barra lateral. Vamos atualizar a página de introdução: Encontre e selecione index.mdx no explorador de arquivos. Em seguida, no editor, atualize o campo de título para “Hello World”.
Editing in Web Editor
O editor oferece um conjunto completo de ferramentas de formatação e Componentes (Mintlify). Digite / no editor para abrir o menu de comandos e acessar essas ferramentas.

​
Publique suas alterações

Quando estiver satisfeito com suas edições, selecione o botão Publish no canto superior direito. Suas alterações são publicadas imediatamente no seu site de documentação.
Use branches para pré-visualizar e revisar alterações por meio de pull requests antes de publicar no seu site em produção.
Para mais detalhes sobre o uso do Editor web, incluindo o uso de branches e pull requests para colaborar e pré-visualizar alterações, consulte nossa documentação do Editor web.

​
Adicionando um domínio personalizado

Embora seu subdomínio <your-project-name>.mintlify.app funcione bem para testes e desenvolvimento, a maioria das equipes prefere usar um domínio personalizado para a documentação em produção. Para adicionar um domínio personalizado, acesse a página Domain Setup no seu dashboard.
Custom Domain
Insira seu domínio (por exemplo, docs.yourcompany.com) e siga as instruções para configurar as configurações de DNS com o seu provedor de domínio.
As alterações de DNS podem levar até 48 horas para propagarem, embora muitas vezes sejam concluídas bem antes.

​
Próximos passos

Parabéns! Você implantou seu site de documentação com a Mintlify com sucesso. Aqui estão alguns próximos passos para aprimorar sua documentação:

Configurar as definições globais

Configure o estilo do site, a navegação, as integrações e muito mais com o arquivo docs.json.

Personalizar o tema

Saiba como personalizar cores, fontes e a aparência geral do seu site de documentação.

Organizar a navegação

Estruture sua documentação com uma navegação intuitiva para ajudar os usuários a encontrar o que precisam.

Adicionar componentes interativos

Aprimore sua documentação com Componentes (Mintlify) interativos como acordeões, abas e exemplos de código.

Configurar referências de API

Crie referências de API interativas com especificações OpenAPI e AsyncAPI.

​
Solução de problemas

Se você encontrar problemas durante a configuração, confira estas soluções comuns: