diff --git a/installation.mdx b/installation.mdx index 9460f9f56..15c4774b7 100644 --- a/installation.mdx +++ b/installation.mdx @@ -24,10 +24,16 @@ icon: "terminal" Run the following command to install the [CLI](https://www.npmjs.com/package/mint): - ```bash + + ```bash npm npm i -g mint ``` + ```bash pnpm + pnpm add -g mint + ``` + + Navigate to your docs directory (where your `docs.json` file is located) and execute the following command: @@ -56,9 +62,15 @@ mint update If this `mint update` command is not available on your local version, re-install the CLI with the latest version: -```bash -npm i -g mint@latest -``` + + ```bash npm + npm i -g mint@latest + ``` + + ```bash pnpm + pnpm add -g mint@latest + ``` + ## Custom ports @@ -137,6 +149,8 @@ If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugin If you have any problems with the CLI package, you should first run `npm ls -g`. This command shows what packages are globally installed on your machine. + + If you don't use npm or don't see it in the -g list, try `which mint` to locate the installation. If you have a package named `mint` and a package named `mintlify` installed, you should uninstall `mintlify`. @@ -150,7 +164,7 @@ If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugin ``` 3. Reinstall the new package: ```bash - npm install -g mint + npm i -g mint ``` diff --git a/quickstart.mdx b/quickstart.mdx index d6e0b3978..4678c7ccd 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -82,9 +82,15 @@ The code-based workflow integrates with your existing development environment an To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running this command in your terminal: -```bash -npm i -g mint -``` + + ```bash npm + npm i -g mint + ``` + + ```bash pnpm + pnpm add -g mint + ``` + You need Node.js installed on your machine. If you encounter installation issues, check the troubleshooting guide.