Skip to main content
Pré-requisitos:
  • Node.js versão 19 ou superior
  • Um repositório de documentação com um arquivo docs.json
Siga estes passos para instalar e executar o Mintlify no seu sistema.
1

Instalar a CLI do Mintlify

npm i -g mint
2

Pré-visualizar localmente

No diretório da documentação onde está o docs.json, execute:
mint dev
A pré-visualização ficará disponível em http://localhost:3000.

​
Portas personalizadas

Por padrão o Mintlify usa a porta 3000. Você pode alterar com a opção --port. Por exemplo, para a porta 3333: 
mint dev --port 3333
Se a porta estiver em uso, a próxima disponível será usada: 
Port 3000 is already in use. Trying 3001 instead.

​
Versões do Mintlify

Cada versão da CLI corresponde a uma versão específica do Mintlify. Se a pré-visualização não bater com produção, atualize a CLI: 
npm mint update
Para identificar links quebrados: 
mint broken-links

​
Implantação

Se a implantação for bem-sucedida, você verá algo como:
Captura de tela de confirmação de implantação: All checks have passed.

​
Formatação de código

Sugerimos extensões no IDE para reconhecer e formatar MDX. No VS Code: extensão MDX e Prettier.

​
Solução de problemas

Pode ser uma versão antiga do Node. Tente:
  1. Remover a CLI: npm remove -g mint
  2. Atualizar para Node v19 ou superior.
  3. Reinstalar: npm i -g mint
Solução: na raiz do usuário, exclua a pasta ~/.mintlify e execute mint dev novamente.
Quer ver o que mudou na CLI? Veja o changelog no npm.