| title | Desenvolvimento |
|---|---|
| description | Visualize mudanças localmente para atualizar sua documentação |
Atualize para ```docs.json``` antes de prosseguir e delete o arquivo legado ```mint.json```.
Siga estes passos para instalar e executar o Mintlify no seu sistema operacional:
Passo 1: Instale o Mintlify:
npm i -g mintlifyyarn global add mintlifyPasso 2: Navegue para o diretório docs (onde o arquivo docs.json está localizado) e execute o seguinte comando:
mintlify devUma pré-visualização local da sua documentação estará disponível em http://localhost:8082.
Por padrão, o Mintlify usa a porta 3000. Você pode customizar a porta que o Mintlify executa usando a flag --port. Para executar o Mintlify na porta 3333, por exemplo, use este comando:
mintlify dev --port 3333Se você tentar executar o Mintlify em uma porta que já está em uso, ele usará a próxima porta disponível:
Porta 3000 já está em uso. Tentando 3001 em vez disso.Observe que cada lançamento da CLI está associado a uma versão específica do Mintlify. Se seu site local não estiver alinhado com a versão de produção, atualize a CLI:
npm i -g mintlify@latestyarn global upgrade mintlifyA CLI pode auxiliar na validação de links de referência feitos na sua documentação. Para identificar links quebrados, use o seguinte comando:
mintlify broken-linksSe o deploy for bem-sucedido, você deve ver o seguinte:
Sugerimos usar extensões no seu IDE para reconhecer e formatar MDX. Se você usa VSCode, considere a extensão MDX para VSCode para destaque de sintaxe, e o Prettier para formatação de código.
Isso pode ser devido a uma versão desatualizada do node. Tente o seguinte:
1. Remova a versão atualmente instalada do mintlify: `npm remove -g mintlify`
2. Atualize para Node v19 ou superior.
3. Reinstale o mintlify: `npm install -g mintlify`
Solução: Vá para a raiz do seu dispositivo e delete a pasta \~/.mintlify. Em seguida, execute `mintlify dev` novamente.
Curioso sobre o que mudou na versão da CLI? Confira o changelog da CLI.