Configure seu ambiente de desenvolvimento#
Aprenda a atualizar sua documentação localmente e implantá-la para o público.
Editar e pré-visualizar#
Clonar sua documentação localmente
Durante o processo de onboarding, criamos um repositório no seu GitHub com o conteúdo da sua documentação. Você pode encontrar esse repositório no nosso dashboard. Para clonar o repositório localmente, siga estas instruções no seu terminal.
Pré-visualizar alterações
A pré-visualização ajuda você a confirmar que suas alterações estão como esperado. Criamos uma
interface de linha de comando para renderizar essas alterações localmente. 1. Instale o
Mintlify CLI para pré-visualizar as
alterações na documentação localmente com este comando: npm i -g mintlify
2. Execute o seguinte comando na raiz da sua documentação (onde
está o mint.json): mintlify dev
Publique suas alterações#
Instale nosso app do GitHub
Nosso app do GitHub publica automaticamente suas alterações no seu site de documentação, para que você não precise gerenciar deploys manualmente. Você pode encontrar o link de instalação no seu dashboard. Depois que o bot for instalado com sucesso, deverá aparecer um check ao lado do hash do commit do repositório.
Envie suas alterações
Faça commit e push das suas alterações para o Git para que sejam atualizadas no seu site de documentação. Se você fizer push e não vir que o app do GitHub publicou suas alterações com sucesso, você também pode atualizar manualmente sua documentação pelo nosso dashboard.
Atualize sua documentação#
Adicione conteúdo diretamente nos seus arquivos com sintaxe MDX e componentes React. Você pode usar qualquer um dos nossos componentes ou até criar os seus.
Dê personalidade à sua documentação com uma identidade visual própria.
Implemente sua especificação OpenAPI e habilite a interação dos usuários com a API.
Obtenha insights a partir das interações dos usuários com sua documentação.
Mantenha sua documentação no subdomínio do seu próprio site.