Mintlify: pré-visualizar documentação no local com o CLI mint

Para quem

Se você mantém documentação Mintlify e quer ver o efeito nesta máquina antes de empurrar para a linha, este repositório oficial de docs serve. É Official Mintlify documentation. O repositório é

https://github.com/mintlify/docs

O site de docs publicado é

https://mintlify.com/docs

O pacote CLI é

https://www.npmjs.com/package/mint

Encaixa melhor quem já tem um diretório de docs com docs.json (este repositório clonado ou o seu projeto Mintlify), consegue executar npm nesta máquina e aceita só este comando oficial de instalação: npm i -g mint. É um CLI global, não um pacote de mercado de skills; não reescreva como skills add.

Se você só quer ler no navegador

https://mintlify.com/docs

e não pretende editar docs nem abrir uma pré-visualização local, não precisa do CLI. Na primeira vez, só pré-visualização local. Não execute um comando de ir ao ar que não apareça nesta página. Esta página não nomeia nenhum cliente de programação; veja a pré-visualização no navegador.

Primeira tentativa em 3 minutos

Use apenas este caminho oficial de instalação:

npm i -g mint

Uma instalação global muda a linha de comando desta máquina. Confirme primeiro que você aceita um pacote global. Não procure plugin nem mercado.

Pré-requisitos: Node/npm está instalado; o diretório de trabalho atual é a raiz de docs, a camada onde docs.json aparece. Se o arquivo ainda não existe, clone primeiro o repositório oficial de docs. Não invente um docs.json num formato não documentado.

Depois execute nessa raiz:

mint dev

Isso inicia uma pré-visualização local e é um processo local. Confirme que a porta só é acessada no local e então execute. Abra no navegador o endereço local que ela imprime e confira se uma página de docs renderiza.

Sinal de sucesso: o comando mint funciona e, após mint dev, você vê no navegador uma árvore de docs correspondente a docs.json, não um erro de docs.json ausente. Se disser que você não está na raiz de docs, cd para o diretório que contém docs.json e rode de novo; não acrescente parâmetros não documentados. Se mint não existir, volte a npm i -g mint; não troque por um nome de pacote não escrito.

Casos de uso

Caso 1: instalar Mint CLI. Oficialmente instale com npm i -g mint para pré-visualizar mudanças de docs no local. Depois de instalar, execute mint no terminal e confirme que o comando entrou no PATH. É um efeito colateral global; não instale à toa num ambiente não confiável. Esta página não escreve número de versão nem substituto npx mint; se faltarem, use só esta instalação global.

Caso 2: pré-visualizar na raiz de docs. Oficialmente execute mint dev na raiz de docs (onde está docs.json). Mude o título ou um parágrafo de uma página md existente, salve e veja se a pré-visualização local atualiza. Não faça um push de ir ao ar na primeira tentativa. Esta página não escreve detalhes de recarga a quente nem uma porta padrão; pegue o endereço de pré-visualização na saída da linha de comando, não chute.

Limites

Isto é o repositório oficial de docs mais a pré-visualização CLI, não um gerador genérico de site estático. Sem docs.json, mint dev não tem ponto de partida oficial.

A instalação oficial é só npm i -g mint. mint dev é pré-visualização, não um segundo instalador. Não invente uma instalação de mercado de skills. O site publicado é referência somente leitura, não fonte de instalação.

O pacote global e iniciar o dev têm efeitos colaterais. Confirme primeiro o diretório. Esta página não dá passos de implantação, hospedagem ou domínio personalizado; não faça ações de ir ao ar não escritas. Também não lista outros subcomandos de mint; não chute comandos que nunca aparecem.