From f43c1c669015b181d5937cccb27792428719ed94 Mon Sep 17 00:00:00 2001 From: Knox Lively Date: Mon, 26 Feb 2024 13:45:59 -0700 Subject: [PATCH] removed development page as its a duplicate, and linked to it in our readme. --- development.mdx | 99 ------------------------------------------------- 1 file changed, 99 deletions(-) delete mode 100644 development.mdx diff --git a/development.mdx b/development.mdx deleted file mode 100644 index 98add64..0000000 --- a/development.mdx +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: 'Development' -description: 'Preview changes locally to update your docs' ---- - - - -**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding. - - - -Follow these steps to install and run Mintlify on your operating system: - -**Step 1**: Install Mintlify: - - - ```bash npm - npm i -g 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: - -```bash -mintlify dev -``` - -A local preview of your documentation will be available at `http://localhost:3000`. - -### Custom Ports - -By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the `--port` flag. To run Mintlify on port 3333, for instance, use this command: - -```bash -mintlify dev --port 3333 -``` - -If you attempt to run Mintlify on a port that's already in use, it will offer an alternative port: - -```md -Port 3000 is already in use. Using port 3001 instead. -``` - -## Mintlify Versions - -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 - ``` - - -## Validating Links - -The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command: - -```bash -mintlify broken-links -``` - -## Deployment - -If the deployment is successful, you should see the following: - - - - - -## Code Formatting - -We suggest using appropriate extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider using the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting. - -## 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