Pré-requisito: Por favor, instale o Node.js (versão 19 ou superior) antes de prosseguir.

Passo 1: Instale a CLI:

npm i -g mint

Passo 2: Navegue até o diretório dos documentos (onde o arquivo docs.json está localizado) e execute o seguinte comando:

mint dev

Alternativamente, se você não quiser instalar a CLI globalmente, você pode usar um script de execução única:

npx mint dev

Uma prévia local da sua documentação estará disponível em http://localhost:3000.

​
Atualizações

Cada lançamento da CLI está associado a uma versão específica da plataforma Mintlify. Se sua prévia local não estiver alinhada com a versão de produção, por favor atualize a CLI:

npm i -g mint@latest

​
Portas Personalizadas

Por padrão, a CLI usa a porta 3000. Você pode personalizar a porta usando a flag --port. Para executar a CLI na porta 3333, por exemplo, use este comando:

mint dev --port 3333

Se você tentar executar em uma porta que já está em uso, ela usará a próxima porta disponível:

Port 3000 is already in use. Trying 3001 instead.

​
Comandos Adicionais

Embora mint dev seja o comando mais comumente usado, existem outros comandos que você pode usar para gerenciar sua documentação.

A CLI pode ajudar a validar links de referência feitos em sua documentação. Para identificar quaisquer links quebrados, use o seguinte comando:

mint broken-links

​
Verificar Especificação OpenAPI

Você pode usar a CLI para verificar seu arquivo OpenAPI em busca de erros usando o seguinte comando:

mint openapi-check <openapiFilenameOrUrl>

Você pode passar um nome de arquivo (por exemplo, ./openapi.yaml) ou uma URL (por exemplo, https://petstore3.swagger.io/api/v3/openapi.json).

​
Renomeando Arquivos

Você pode renomear arquivos usando o seguinte comando:

mint rename <oldFilename> <newFilename>

Isso é uma melhoria em relação à atualização normal do nome do arquivo, pois também atualizará todas as referências ao arquivo, garantindo que não haja links quebrados.

​
Formatação

Durante o desenvolvimento local, recomendamos usar extensões em seu IDE para reconhecer e formatar MDX.

Se você usa Cursor, Windsurf ou VSCode, recomendamos a extensão MDX VSCode para realce de sintaxe, e Prettier para formatação de código.

Se você usa JetBrains, recomendamos o plugin MDX IntelliJ IDEA para destaque de sintaxe e configuração Prettier para formatação de código.

​
Solução de problemas