Quickstart
Este guia de início rápido o guiará pelo processo de configuração e implantação do seu site de documentação em apenas alguns minutos.
Ao final deste guia, você terá um site de documentação ao vivo pronto para ser personalizado e expandido.
Pré-requisitos: Antes de começar, certifique-se decriar uma contae completar o onboarding.
Começando
Depois de completar o processo de onboarding, seu site de documentação será automaticamente implantado em uma URL única com o seguinte formato.
Você pode encontrar sua URL na página de Visão Geral do painel.
Esta URL está instantaneamente disponível e será atualizada sempre que você fizer alterações em sua documentação. É perfeita para testes e compartilhamento com sua equipe durante o desenvolvimento.
Instale o Aplicativo GitHub
O Mintlify fornece um Aplicativo GitHub que automatiza o processo de implantação quando você envia alterações para seu repositório.
Você pode instalar o Aplicativo GitHub seguindo as instruções da lista de verificação de onboarding ou do seu painel.
- Navegue atéConfiguraçõesno seu painel Mintlify.
- SelecioneAplicativo GitHubna barra lateral.
- SelecioneInstalar Aplicativo GitHub. Isso abrirá uma nova aba para a página de instalação do Aplicativo GitHub.
- Selecione a organização ou conta de usuário onde deseja instalar o aplicativo. Em seguida, selecione os repositórios que deseja conectar.
Lembre-se de atualizar as permissões do Aplicativo GitHub se você mover a documentação para um repositório diferente.
Autorize sua Conta GitHub
- Navegue atéConfiguraçõesno seu painel Mintlify.
- SelecioneMeu Perfilna barra lateral.
- SelecioneAutorizar conta GitHub. Isso abrirá uma nova aba para a página de autorização do GitHub.
Você pode precisar de um administrador para sua organização GitHub autorizar sua conta, dependendo das configurações da sua organização.
Fluxos de Trabalho de Edição
O Mintlify oferece dois fluxos de trabalho diferentes para criar e manter sua documentação.
Fluxo de trabalho baseado em código
Para desenvolvedores que preferem trabalhar com suas ferramentas existentes. Clique para ir para a seção.
Fluxo de trabalho do editor web
Para aqueles que preferem uma interface visual. Clique para ir para a seção.
Fluxo de Trabalho Baseado em Código
O fluxo de trabalho baseado em código integra-se ao seu ambiente de desenvolvimento existente e repositórios Git, tornando-o ideal para equipes técnicas que desejam gerenciar a documentação junto com seu código.
Instale a CLI
Para trabalhar localmente com sua documentação, instale a Interface de Linha de Comando (CLI), chamadamint, executando o seguinte comando em seu terminal:
Você precisa ter o Node.js versão 19 ou superior instalado em sua máquina. Se encontrar problemas de instalação, verifique o guia de solução de problemas.
Edite a Documentação
Agora que seu ambiente está configurado, você pode começar a editar seus arquivos de documentação. Como exemplo, vamos atualizar o título da página de introdução:
Abra o repositório criado durante o onboarding, encontre ointroduction.mdxarquivo, e encontre o topo do arquivo, que deve se parecer com isto:
Atualize o campotitlepara"Hello World".
Visualize as Alterações
Para visualizar as alterações localmente, execute o seguinte comando.
Sua visualização estará disponível emlocalhost:3000.
Envie as Alterações
Quando estiver pronto para publicar suas alterações, simplesmente envie as mudanças para o seu repositório.
Mintlify detectará automaticamente as alterações, construirá sua documentação e implantará as atualizações em seu site. Você pode monitorar o status da implantação no histórico de commits do seu repositório GitHub ou nodashboard.
Uma vez que a implantação esteja completa, sua última atualização estará disponível em<your-project-name>.mintlify.app.
Pular para adicionar 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 fornece uma interface “o que você vê é o que você obtém” (WYSIWYG) para criar e editar documentação. É ideal para pessoas que querem trabalhar em seu navegador web sem ferramentas adicionais de desenvolvimento local.
Acesse o Editor Web
- Faça login no seuMintlify Dashboard.
- SelecioneEditorna barra lateral esquerda.
Se você não instalou o GitHub App, será solicitado a fazê-lo ao abrir o editor web.
Edite a Documentação
No editor web, você pode navegar pelos seus arquivos de documentação na barra lateral. Vamos atualizar a página de introdução.
Encontre e clique emintroduction.mdxno explorador de arquivos.
Em seguida, no editor visual, atualize o campo de título para “Hello World”.
O editor fornece um rico conjunto de ferramentas de formatação e componentes. Acesse-os digitando ”/” no editor para abrir o menu de comandos.
Publique Suas Alterações
Quando estiver satisfeito com suas edições, clique no botãoPublishno canto superior direito.
Suas alterações serão implantadas imediatamente no seu site de documentação.
Para mais detalhes sobre o uso do editor web, incluindo recursos avançados como comandos de barra e uploads de imagens, consulte nossadocumentação do Editor Web.
Adicionando um Domínio Personalizado
Embora seu subdomínio<your-project-name>.mintlify.appfuncione bem para testes e desenvolvimento, a maioria das equipes prefere usar um domínio personalizado para documentação em produção.
Para adicionar um domínio personalizado, vá paraSettings>Custom Domainno dashboard.
Digite seu domínio (por exemplo, docs.suaempresa.com) e siga as instruções fornecidas para configurar as configurações de DNS com seu provedor de domínio.
As alterações de DNS podem levar até 48 horas para se propagar, embora frequentemente sejam concluídas muito mais rápido.
Próximos Passos
Parabéns! Você implantou com sucesso seu site de documentação com Mintlify. Aqui estão alguns próximos passos sugeridos para aprimorar sua documentação:
Personalize Seu Tema
Aprenda como personalizar cores, fontes e a aparência geral do seu site de documentação.
Organize a Navegação
Estruture sua documentação com uma navegação intuitiva para ajudar os usuários a encontrar o que precisam.
Adicione Componentes Interativos
Aprimore sua documentação com componentes interativos como acordeões, abas e exemplos de código.
Configure Referências de API
Crie referências de API interativas com especificações OpenAPI e AsyncAPI.
Solução de Problemas
Se você encontrar algum problema durante o processo de configuração, verifique nossas soluções comuns de solução de problemas:
Precisa de mais ajuda?Entre em contato com nossa Equipe de Suporte.