diff --git a/code.mdx b/code.mdx index 498319a65..3df369636 100644 --- a/code.mdx +++ b/code.mdx @@ -8,13 +8,15 @@ icon: 'code' ### Inline Code +* test 1 + To denote a `word` or `phrase` as code, enclose it in backticks (\`). ``` To denote a `word` or `phrase` as code, enclose it in backticks (`). ``` - +![](/yellow-bg.png) ### Code Block diff --git a/development.mdx b/development.mdx index 9358c1ffa..5ea654183 100644 --- a/development.mdx +++ b/development.mdx @@ -4,15 +4,12 @@ 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 the Mintlify CLI: - ```bash npm npm i -g mintlify ``` @@ -24,7 +21,6 @@ description: 'Preview changes locally to update your docs' ```bash pnpm pnpm add -g mintlify ``` - **Step 2**: Navigate to the docs directory (where the `docs.json` file is located) and execute the following command: @@ -47,7 +43,6 @@ Alternatively, if you do not want to install the CLI globally you can use a run ```bash pnpm pnpm dlx mintlify dev ``` - @@ -75,7 +70,6 @@ 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 ``` @@ -87,7 +81,6 @@ Please note that each CLI release is associated with a specific version of Mintl ```bash pnpm pnpm up --global mintlify ``` - ## Validating Links @@ -103,10 +96,7 @@ mintlify broken-links If the deployment is successful, you should see the following: - + ## Code Formatting @@ -116,16 +106,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 diff --git a/yellow-bg.png b/yellow-bg.png new file mode 100644 index 000000000..3d90449e4 Binary files /dev/null and b/yellow-bg.png differ