Pular para o conteúdo principal
Pré-requisitos: - Node.js versão 19 ou superior - Um repositório de docs com um arquivo docs.json
Siga estes passos para instalar e executar o Mintlify no seu sistema operacional.
1

Instalar o CLI do Mintlify

npm i -g mint
2

Visualizar localmente

Navegue até o diretório da sua documentação onde o arquivo docs.json está localizado e execute o seguinte comando:
mint dev
Uma visualização local da sua documentação estará disponível em http://localhost:3000.

​
Portas personalizadas

Por padrão, o Mintlify usa a porta 3000. Você pode personalizar a porta em que o Mintlify é executado usando a flag --port. Por exemplo, para executar o Mintlify na porta 3333, use este comando: 
mint dev --port 3333
Se você tentar executar o Mintlify em uma porta que já está em uso, ele usará a próxima porta disponível: 
Port 3000 is already in use. Trying 3001 instead.

​
Versões do Mintlify

Observe que cada versão do CLI está associada a uma versão específica do Mintlify. Se sua visualização local não estiver alinhada com a versão de produção, atualize o CLI: 
mint update
O CLI pode ajudar a validar links na sua documentação. Para identificar links quebrados, use o seguinte comando: 
mint broken-links

​
Deploy

Se o deploy for bem-sucedido, você verá o seguinte:
Captura de tela de uma mensagem de confirmação de deploy que diz All checks have passed.

​
Formatação de código

Sugerimos usar extensões no seu IDE para reconhecer e formatar MDX. Se você usa VSCode, considere a extensão MDX VSCode para destaque de sintaxe, e Prettier para formatação de código.

​
Solução de problemas

Isso pode ser devido a uma versão desatualizada do node. Tente o seguinte:
  1. Remova a versão atualmente instalada do CLI: npm remove -g mint
  2. Atualize para o Node v19 ou superior.
  3. Reinstale o CLI: npm i -g mint
Solução: Vá até a raiz do seu dispositivo e delete a pasta ~/.mintlify. Depois execute mint dev novamente.
Curioso sobre o que mudou na última versão do CLI? Confira o changelog do CLI.