> ## Documentation Index
> Fetch the complete documentation index at: https://docs.costcare.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API

> Переглядайте зміни локально для оновлення документації

<Info>
  **Передумови**:

  * Node.js версії 19 або вище
  * Репозиторій документації з файлом `docs.json`
</Info>

Виконайте ці кроки, щоб встановити та запустити Mintlify у вашій операційній системі.

<Steps>
  <Step title="Встановіть Mintlify CLI">
    ```bash theme={null}
    npm i -g mint
    ```
  </Step>

  <Step title="Перегляньте локально">
    Перейдіть до директорії з документацією, де знаходиться файл `docs.json`, та виконайте команду:

    ```bash theme={null}
    mint dev
    ```

    Локальний попередній перегляд документації буде доступний за адресою `http://localhost:3000`.
  </Step>
</Steps>

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

За замовчуванням Mintlify використовує порт 3000. Ви можете змінити порт за допомогою прапорця `--port`. Наприклад, щоб запустити Mintlify на порту 3333, виконайте команду:

```bash theme={null}
mint dev --port 3333
```

Якщо ви спробуєте запустити Mintlify на порту, що вже використовується, він перейде на наступний доступний порт:

```md theme={null}
Port 3000 is already in use. Trying 3001 instead.
```

## Версії Mintlify

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

```bash theme={null}
npm mint update
```

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

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

```bash theme={null}
mint broken-links
```

## Деплой

Якщо деплой пройшов успішно, ви побачите наступне:

<Frame>
  <img src="https://mintcdn.com/costcare/WsPaeEJGrmCAXBab/images/checks-passed.png?fit=max&auto=format&n=WsPaeEJGrmCAXBab&q=85&s=04b9b29a4d757baad8e152320caa00c2" alt="Screenshot of a deployment confirmation message that says All checks have passed." style={{ borderRadius: '0.5rem' }} width="1100" height="346" data-path="images/checks-passed.png" />
</Frame>

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

Ми рекомендуємо використовувати розширення для IDE для розпізнавання та форматування MDX. Якщо ви користуєтесь VSCode, зверніть увагу на [розширення MDX VSCode](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) для підсвічування синтаксису та [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) для форматування коду.

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

<AccordionGroup>
  <Accordion title="Помилка: Could not load the &#x22;sharp&#x22; module using the darwin-arm64 runtime">
    Це може бути пов'язано із застарілою версією Node. Спробуйте наступне:

    1. Видаліть поточну версію CLI: `npm remove -g mint`
    2. Оновіть Node до v19 або вище.
    3. Перевстановіть CLI: `npm i -g mint`
  </Accordion>

  <Accordion title="Проблема: Невідома помилка">
    Рішення: Перейдіть до кореневої директорії вашого пристрою та видаліть папку `~/.mintlify`. Потім знову запустіть `mint dev`.
  </Accordion>
</AccordionGroup>

Цікавитеся, що змінилося в останній версії CLI? Перегляньте [журнал змін CLI](https://www.npmjs.com/package/mintlify?activeTab=versions).