Перейти до основного вмісту
Передумови:
  • Node.js версії 19 або вище
  • Репозиторій документації з файлом docs.json
Виконайте ці кроки, щоб встановити та запустити Mintlify у вашій операційній системі.
1

Встановіть Mintlify CLI

npm i -g mint
2

Перегляньте локально

Перейдіть до директорії з документацією, де знаходиться файл docs.json, та виконайте команду:
mint dev
Локальний попередній перегляд документації буде доступний за адресою http://localhost:3000.

​
Нестандартні порти

За замовчуванням Mintlify використовує порт 3000. Ви можете змінити порт за допомогою прапорця --port. Наприклад, щоб запустити Mintlify на порту 3333, виконайте команду: 
mint dev --port 3333
Якщо ви спробуєте запустити Mintlify на порту, що вже використовується, він перейде на наступний доступний порт: 
Port 3000 is already in use. Trying 3001 instead.

​
Версії Mintlify

Зверніть увагу, що кожен реліз CLI пов’язаний з певною версією Mintlify. Якщо ваш локальний попередній перегляд не відповідає робочій версії, оновіть CLI: 
npm mint update

​
Перевірка посилань

CLI може допомогти з перевіркою посилань у вашій документації. Щоб знайти будь-які недійсні посилання, виконайте команду: 
mint broken-links

​
Деплой

Якщо деплой пройшов успішно, ви побачите наступне:
Screenshot of a deployment confirmation message that says All checks have passed.

​
Форматування коду

Ми рекомендуємо використовувати розширення для IDE для розпізнавання та форматування MDX. Якщо ви користуєтесь VSCode, зверніть увагу на розширення MDX VSCode для підсвічування синтаксису та Prettier для форматування коду.

​
Усунення несправностей

Це може бути пов’язано із застарілою версією Node. Спробуйте наступне:
  1. Видаліть поточну версію CLI: npm remove -g mint
  2. Оновіть Node до v19 або вище.
  3. Перевстановіть CLI: npm i -g mint
Рішення: Перейдіть до кореневої директорії вашого пристрою та видаліть папку ~/.mintlify. Потім знову запустіть mint dev.
Цікавитеся, що змінилося в останній версії CLI? Перегляньте журнал змін CLI.