From 0f06c2e0fa8db278b8adeb21168936618f8c709f Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 18 Nov 2024 16:20:55 +0000 Subject: [PATCH] Documentation edits made through Mintlify web editor --- development.mdx | 44 +++++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/development.mdx b/development.mdx index 15581014..15503cfd 100644 --- a/development.mdx +++ b/development.mdx @@ -4,27 +4,33 @@ description: 'Preview changes locally to update your docs' --- - -**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding. - + **Prerequisite**: Please install Node.js (version 19 or higher) before proceeding. **Step 1**: Install Mintlify: - ```bash npm npm i -g mintlify ``` -```bash yarn -yarn global add mintlify -``` - + ```bash yarn + yarn global add mintlify + ``` **Step 2**: Navigate to the docs directory (where the `mint.json` file is located) and execute the following command: + + + + Callout Content + + test chargebee + + + + ```bash mintlify dev ``` @@ -50,15 +56,13 @@ Port 3000 is already in use. Trying 3001 instead. Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI: - ```bash npm npm i -g mintlify@latest ``` -```bash yarn -yarn global upgrade mintlify -``` - + ```bash yarn + yarn global upgrade mintlify + ``` ## Validating Links @@ -74,10 +78,7 @@ mintlify broken-links If the deployment is successful, you should see the following: - + ## Code Formatting @@ -87,16 +88,17 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a ## Troubleshooting - - + This may be due to an outdated version of node. Try the following: + 1. Remove the currently-installed version of mintlify: `npm remove -g mintlify` + 2. Upgrade to Node v19 or higher. + 3. Reinstall mintlify: `npm install -g mintlify` - Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again. - + \ No newline at end of file