​
Installazione della CLI

Prerequisito: Installa Node.js prima di procedere.
1

Installa la CLI.

Esegui il seguente comando per installare la CLI:
npm i -g mint
2

Anteprima locale.

Vai alla directory della documentazione (dove si trova il file docs.json) ed esegui il seguente comando:
mint dev
Un’anteprima locale della documentazione sarà disponibile all’indirizzo http://localhost:3000.
In alternativa, se non vuoi installare la CLI a livello globale, puoi eseguire uno script una tantum: 
npx mint dev

​
Aggiornamenti

Se l’anteprima locale non è sincronizzata con quanto vedi online nella versione di produzione, aggiorna la CLI locale: 
mint update
Se il comando mint update non è disponibile nella tua versione locale, reinstalla la CLI all’ultima versione: 
npm i -g mint@latest

​
Porte personalizzate

Per impostazione predefinita, la CLI usa la porta 3000. Puoi personalizzare la porta con il flag --port. Per eseguire la CLI sulla porta 3333, ad esempio, usa questo comando: 
mint dev --port 3333
Se provi a eseguire su una porta già in uso, verrà utilizzata la successiva porta disponibile: 
La porta 3000 è già in uso. Provo con la 3001.

​
Anteprima come gruppo specifico

Se utilizzi l’autenticazione parziale per limitare l’accesso alla documentazione, puoi visualizzare l’anteprima come uno specifico gruppo di autenticazione usando il flag --group [groupname]. Ad esempio, se hai un gruppo chiamato admin, puoi visualizzare l’anteprima come membro di quel gruppo con il comando: 
mint dev --group admin

​
Comandi aggiuntivi

Sebbene mint dev sia il comando usato più frequentemente, ci sono altri comandi che puoi utilizzare per gestire la documentazione. La CLI può aiutarti a convalidare i link di riferimento presenti nella documentazione. Per identificare eventuali link interrotti, usa il seguente comando: 
mint broken-links

​
Verifica della specifica OpenAPI

Puoi usare la CLI per controllare il file OpenAPI e individuare eventuali errori con il seguente comando: 
mint openapi-check <openapiFilenameOrUrl>
Puoi fornire un nome file (ad es. ./openapi.yaml) o un URL (ad es. https://petstore3.swagger.io/api/v3/openapi.json).

​
Rinomina dei file

Puoi rinominare i file e aggiornare tutti i riferimenti usando il seguente comando: 
mint rename <oldFilename> <newFilename>

​
Migrazione delle pagine endpoint MDX

Puoi migrare le pagine endpoint MDX in pagine autogenerate a partire dalla tua specifica OpenAPI usando il seguente comando: 
mint migrate-mdx
Questo comando converte le singole pagine endpoint MDX in pagine autogenerate definite nel tuo docs.json, sposta il contenuto MDX nell’estensione x-mint della tua specifica OpenAPI e aggiorna la navigazione. Consulta Migrazione da MDX per informazioni dettagliate.

​
Formattazione

Durante lo sviluppo in locale, consigliamo di usare estensioni nel tuo IDE per riconoscere e formattare i file MDX. Se usi Cursor, Windsurf o VS Code, consigliamo l’estensione MDX per VS Code per l’evidenziazione della sintassi e Prettier per la formattazione del codice. Se usi JetBrains, consigliamo il plugin MDX per IntelliJ IDEA per l’evidenziazione della sintassi e la configurazione di Prettier per la formattazione del codice.

​
Risoluzione dei problemi