# mint-mojito

> The Mintlify CLI

Latest version **1.2.0** (published 2022-12-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install mint-mojito
pnpm add mint-mojito
yarn add mint-mojito
bun add mint-mojito
```

Provides the command `mintlify`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2022-12-18 |
| First published | 2022-12-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM |
| Node | >=14.16 |
| Dependencies | 18 |
| Unpacked size | 221.5 KB |
| Known vulnerabilities | 0 (+31 in 1 direct dependencies) |
| Install scripts | no |
| Author | Mintlify, Inc. |
| Maintainers | rayepps |

## Links

- npm: https://www.npmjs.com/package/mint-mojito
- npm.io page: https://npm.io/package/mint-mojito

## Dependencies (18)

- [ora](https://npm.io/package/ora.md) ^6.1.2
- [open](https://npm.io/package/open.md) ^8.4.0
- [axios](https://npm.io/package/axios.md) 1.1.3
- [chalk](https://npm.io/package/chalk.md) ^5.1.0
- [yargs](https://npm.io/package/yargs.md) ^17.6.0
- [cheerio](https://npm.io/package/cheerio.md) ^0.22.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.5
- [chokidar](https://npm.io/package/chokidar.md) ^3.5.3
- [favicons](https://npm.io/package/favicons.md) ^7.0.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^9.1.0
- [puppeteer](https://npm.io/package/puppeteer.md) ^19.4.0
- [gray-matter](https://npm.io/package/gray-matter.md) ^4.0.3
- [minimist-lite](https://npm.io/package/minimist-lite.md) ^2.2.1
- [openapi-types](https://npm.io/package/openapi-types.md) ^12.0.2
- [node-html-markdown](https://npm.io/package/node-html-markdown.md) ^1.3.0
- [is-internet-available](https://npm.io/package/is-internet-available.md) ^3.1.0
- [@apidevtools/swagger-parser](https://npm.io/package/@apidevtools/swagger-parser.md) ^10.1.0

## Recent versions

- 1.2.0 (latest) — 2022-12-18
- 2.0.0-rc.2 (next) — 2022-12-18
- 2.0.0-rc.1 — 2022-12-18

## README

<div align="center">
  <a href="https://mintlify.com">
    <img
      src="https://res.cloudinary.com/mintlify/image/upload/v1665385627/logo-rounded_zuk7q1.svg"
      alt="Mintlify Logo"
      height="64"
    />
  </a>
  <br />
  <p>
    <h3>
      <b>
        Mintlify CLI
      </b>
    </h3>
  </p>
  <p>
    The Mintlify CLI is the easiest way to build Mintlify apps from the command line.
  </p>
  <p>

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)](/) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fmintlify.com&logo=mintlify)](https://mintlify.com) [![Tests](https://github.com/mintlify/mint/actions/workflows/manual.yml/badge.svg)](https://github.com/mintlify/mint/actions) [![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Fmintlify.com%2F)](https://twitter.com/intent/tweet?url=&text=Check%20out%20%40mintlify) [![Chat on Discord](https://img.shields.io/badge/chat-Discord-7289DA?logo=discord)](https://discord.gg/MPNgtSZkgK) [![Discuss on GitHub](https://img.shields.io/badge/discussions-GitHub-333333?logo=github)](https://github.com/mintlify/mint/discussions)

  </p>
  <p>
    <sub>
      Built with ❤︎ by
      <a href="https://mintlify.com">
        Mintlify
      </a>
    </sub>
  </p>
</div>

### 🚀 Installation

Download the Mintlify CLI using the following command

```
npm i mintlify -g
```

### 👩‍💻 Development

Run the following command at the root of your Mintlify application to preview changes locally.

```
mintlify dev
```

Note - `mintlify dev` requires `yarn` and it's recommended you install it as a global installation. If you don't have yarn installed already run `npm install --global yarn` in your terminal.

#### Troubleshooting

Steps you can take if the dev CLI is not working (After each step try to run `mintlify dev` again):

- Make sure you are using Node v18 or higher.
- Run `mintlify install` to re-install dependencies.
- Navigate to the `.mintlify` folder in your home directory and delete its contents.
- If all else fails navigate to `~/.mintlify` and `git clone https://github.com/mintlify/mint.git --branch legacy-components-import`

### 🏃 Get Started

[Create an account](https://mintlify.com/start) to start using Mintlify for your documentation.

---
_Source: https://npm.io/package/mint-mojito · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._