From 81190a47628616109ae474ccb4be8d96eb37beaf Mon Sep 17 00:00:00 2001 From: Knox Lively Date: Mon, 26 Feb 2024 12:02:49 -0700 Subject: [PATCH] updated development page using latest from mintlify --- development.mdx | 93 +++++++++++++++++++++++++------------------------ 1 file changed, 47 insertions(+), 46 deletions(-) diff --git a/development.mdx b/development.mdx index 8783008..98add64 100644 --- a/development.mdx +++ b/development.mdx @@ -1,20 +1,22 @@ --- title: 'Development' -description: 'Learn how to preview changes locally' +description: 'Preview changes locally to update your docs' --- - **Prerequisite** You should have installed Node.js (version 18.10.0 or - higher). + +**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding. + -Step 1. Install Mintlify on your OS: +Follow these steps to install and run Mintlify on your operating system: + +**Step 1**: Install Mintlify: - -```bash npm -npm i -g mintlify -``` + ```bash npm + npm i -g mintlify + ``` ```bash yarn yarn global add mintlify @@ -22,77 +24,76 @@ yarn global add mintlify -Step 2. Go to the docs are located (where you can find `mint.json`) and run the following command: +**Step 2**: Navigate to the docs directory (where the `mint.json` file is located) and execute the following command: ```bash mintlify dev ``` -The documentation website is now available at `http://localhost:3000`. +A local preview of your documentation will be available at `http://localhost:3000`. ### Custom Ports -Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333: +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 ``` -You will see an error like this if you try to run Mintlify in a port that's already taken: +If you attempt to run Mintlify on a port that's already in use, it will offer an alternative port: ```md -Error: listen EADDRINUSE: address already in use :::3000 +Port 3000 is already in use. Using port 3001 instead. ``` ## Mintlify Versions -Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production. +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 npm -npm i -g mintlify@latest -``` - -```bash yarn -yarn global upgrade mintlify -``` - + ```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 - - Unlimited editors available under the [Startup - Plan](https://mintlify.com/pricing) - - -You should see the following if the deploy successfully went through: +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 -Here's how to solve some common problems when working with the CLI. - - - Update to Node v18. Run `mintlify install` and try again. + + 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` - -Go to the `C:/Users/Username/.mintlify/` directory and remove the `mint` -folder. Then Open the Git Bash in this location and run `git clone -https://github.com/mintlify/mint.git`. - -Repeat step 3. + + Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again. - - Try navigating to the root of your device and delete the ~/.mintlify folder. - Then run `mintlify dev` again. - - - -Curious about what changed in a CLI version? [Check out the CLI changelog.](/changelog/command-line) + \ No newline at end of file