Pular para o conteúdo principal

​
Comece em três passos

Tenha seu site de documentação rodando localmente e faça sua primeira personalização.

​
Passo 1: Configure seu ambiente local

Durante o processo de configuração, você criou um repositório GitHub com o conteúdo da sua documentação. Você pode encontrar um link para este repositório em seu painel.Para clonar o repositório localmente e fazer alterações em sua documentação, siga o guia Clonando 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.

​
Passo 2: Publique suas alterações

Instale o app GitHub do Mintlify em seu painel.Nosso app GitHub implanta automaticamente suas alterações no site da documentação, então você não precisa gerenciar implantações sozinho.
Para uma primeira alteração, vamos atualizar o nome e cores do seu site de documentação.
  1. Abra docs.json em seu editor.
  2. Altere o campo "name" para o nome do seu projeto.
  3. Atualize as "colors" para combinar com 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!

​
Passo 3: Torne público

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

​
Próximos passos

Agora que você tem sua documentação funcionando, 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 combinar perfeitamente com sua marca.

Documentação Legal

Acesse nossos termos de serviço e política de privacidade.

Suporte

Precisa de ajuda? Entre em contato conosco.
Precisa de ajuda? Veja nossa documentação completa ou junte-se à nossa comunidade.