From 8545a2afa3585b4105c36c6cbdffc6411b69e451 Mon Sep 17 00:00:00 2001 From: Kathryn Isabelle Lawrence Date: Thu, 26 Jun 2025 14:01:15 -0700 Subject: [PATCH 1/3] update cli docs --- installation.mdx | 53 ++++++++++++++++++++++-------------------------- 1 file changed, 24 insertions(+), 29 deletions(-) diff --git a/installation.mdx b/installation.mdx index d195c937f..51211f719 100644 --- a/installation.mdx +++ b/installation.mdx @@ -29,16 +29,6 @@ icon: "terminal" npm i -g mint ``` - - ```bash yarn - yarn global add mint - ``` - - - ```bash pnpm - pnpm add -g mint - ``` - @@ -61,15 +51,6 @@ npx mint dev ``` -```bash yarn -yarn dlx mint dev -``` - - -```bash pnpm -pnpm dlx mint dev -``` - ## Updates @@ -89,15 +70,6 @@ npm i -g mint@latest ``` -```bash yarn -yarn global upgrade mint -``` - - -```bash pnpm -pnpm up --global mint -``` - ## Custom ports @@ -158,11 +130,34 @@ If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugin This may be due to an outdated version of node. Try the following: - 1. Remove the currently-installed version of the mint CLI: `npm remove -g mint` + 1. Remove the currently-installed version of the mint CLI: `npm uninstall -g mint` 2. Upgrade to Node.js. 3. Reinstall the mint CLI: `npm install -g mint` Solution: Go to the root of your device and delete the `~/.mintlify` folder. Afterwards, run `mint dev` again. + + This is due to not having the required permissions to globally install node packages. + Solution: Try running `sudo npm i -g mint`. You will be prompted for your password, which is the one you use to unlock your computer. + + + Likely this is due to an outdated version of the CLI. + Solution: Run `mint update` to get the latest changes. + + + When having any problems with the CLI package, the first thing we'll ask you to do when troubleshooting is paste the output of `npm ls -g`, which shows what packages are globally installed on your machine. You may see that you have a package named "mint" and a package named "mintlify" installed. It will be less confusing to have only one of them installed. + 1. Uninstall the old package: + ```bash + npm uninstall -g mintlify + ``` + 2. Clear your npm cache: + ```bash + npm cache clean --force + ``` + 3. Reinstall the new package: + ```bash + npm install -g mint + ``` + From 26b9cd52407dda96bacf405024f7391efc4f2e69 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 26 Jun 2025 14:16:33 -0700 Subject: [PATCH 2/3] remove CodeGroup tags --- installation.mdx | 18 +++--------------- 1 file changed, 3 insertions(+), 15 deletions(-) diff --git a/installation.mdx b/installation.mdx index 51211f719..27606d53a 100644 --- a/installation.mdx +++ b/installation.mdx @@ -23,13 +23,11 @@ icon: "terminal" Run the following command to install the [CLI](https://www.npmjs.com/package/mint): - - ```bash npm + ```bash npm i -g mint ``` - Navigate to your docs directory (where your `docs.json` file is located) and execute the following command: @@ -44,15 +42,10 @@ icon: "terminal" Alternatively, if you do not want to install the CLI globally, you can run a one-time script: - - -```bash npm +```bash npx mint dev ``` - - - ## Updates If your local preview is out of sync with what you see on the web in the production version, update your local CLI: @@ -63,15 +56,10 @@ mint update If this `mint update` command is not available on your local version, re-install the CLI with the latest version: - - -```bash npm +```bash npm i -g mint@latest ``` - - - ## Custom ports By default, the CLI uses port 3000. You can customize the port using the `--port` flag. To run the CLI on port 3333, for instance, use this command: From bfbb167e1b8b5343aa3969a5b1bef2662d16d823 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 26 Jun 2025 14:22:37 -0700 Subject: [PATCH 3/3] format troubleshooting steps --- installation.mdx | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/installation.mdx b/installation.mdx index 27606d53a..9460f9f56 100644 --- a/installation.mdx +++ b/installation.mdx @@ -123,18 +123,23 @@ If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugin 3. Reinstall the mint CLI: `npm install -g mint` - Solution: Go to the root of your device and delete the `~/.mintlify` folder. Afterwards, run `mint dev` again. + **Solution**: Go to the root of your device and delete the `~/.mintlify` folder. Afterwards, run `mint dev` again. This is due to not having the required permissions to globally install node packages. - Solution: Try running `sudo npm i -g mint`. You will be prompted for your password, which is the one you use to unlock your computer. + + **Solution**: Try running `sudo npm i -g mint`. You will be prompted for your password, which is the one you use to unlock your computer. - Likely this is due to an outdated version of the CLI. - Solution: Run `mint update` to get the latest changes. + This is likely due to an outdated version of the CLI. + + **Solution:** Run `mint update` to get the latest changes. - When having any problems with the CLI package, the first thing we'll ask you to do when troubleshooting is paste the output of `npm ls -g`, which shows what packages are globally installed on your machine. You may see that you have a package named "mint" and a package named "mintlify" installed. It will be less confusing to have only one of them installed. + 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 have a package named `mint` and a package named `mintlify` installed, you should uninstall `mintlify`. + 1. Uninstall the old package: ```bash npm uninstall -g mintlify