PR Summary

installation.mdx

@@ -1,7 +1,7 @@
 ---
 title: "CLI installation"
 description: "Use the CLI to preview docs locally, test changes in real-time, and catch issues before deploying your documentation site."
 keywords: ["CLI", "npm", "local development", "Node.js"]
 ---
 
 <img
@@ -15,14 +15,14 @@
   alt="Decorative graphic representing the CLI."
 />
 
 Use the CLI to preview your documentation locally as you write and edit. View changes in real-time before deploying, test your documentation site's appearance and functionality, and catch issues like broken links or accessibility problems.
 
 The CLI also has utilities for maintaining your documentation, including commands to rename files, validate OpenAPI specifications, and migrate content between formats.
 
 ## Install the CLI
 
 <Info>
   **Prerequisite**: The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher through v24. LTS versions are preferred.
 </Info>
 
 Run the following command to install the [CLI](https://www.npmjs.com/package/mint):
@@ -39,7 +39,7 @@
 
 ## Preview locally
 
 To generate a local preview, navigate to your documentation directory (where your `docs.json` file is located) and run the following command:
 
 ```bash
 mint dev
@@ -47,7 +47,7 @@
 
 A local preview of your documentation is available at `http://localhost:3000`.
 
 Alternatively, if you do not want to install the CLI globally, you can run a one-time script:
 
 ```bash
 npx mint dev
@@ -55,13 +55,13 @@
 
 ### 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:
 
 ```bash
 mint dev --port 3333
 ```
 
 If you attempt to run on a port that is already in use, it will use the next available port:
 
 ```mdx
 Port 3000 is already in use. Trying 3001 instead.
@@ -85,13 +85,13 @@
 mint new [directory]
 ```
 
 This command clones the [starter kit](https://github.com/mintlify/starter) into a specified directory. If no directory is specified, the CLI tool prompts you to create a new subdirectory or overwrite the current directory.
 
 <Warning>
   If you overwrite the current directory, any existing files in the directory will be deleted.
 </Warning>
 
 The CLI tool prompts you for a project name and [theme](/customize/themes) to finish setting up your project.
 
 You can run `mint new` with the following flags:
 
@@ -104,15 +104,15 @@
 ```bash
 mint new docs --name my-project --theme linden
 ```
 ## Update the CLI
 
 If your local preview is out of sync with what you see on the web in the production version, update your local CLI:
 
 ```bash
 mint update
 ```
 
 If this `mint update` command is not available on your local version, re-install the CLI with the latest version:
 
  <CodeGroup>
     ```bash npm
@@ -134,6 +134,8 @@
 mint broken-links
 ```
 
+The command ignores files matching [.mintignore](/organize/mintignore) patterns. Links that point to ignored files are reported as broken.
+
 ### Find accessibility issues
 
 Test the color contrast ratios and search for missing alt text on images and videos in your documentation with the following command:
@@ -150,7 +152,7 @@
 mint openapi-check <OpenAPI filename or URL>
 ```
 
 Pass a filename (for example, `./openapi.yaml`) or a URL (for example, `https://petstore3.swagger.io/api/v3/openapi.json`).
 
 ### Rename files
 
@@ -172,11 +174,11 @@
 
 ## Formatting
 
 While developing locally, we recommend using extensions in your IDE to recognize and format MDX files.
 
 If you use Cursor, Windsurf, or VS Code, we recommend the [MDX VS Code 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.
 
 If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugins.jetbrains.com/plugin/14944-mdx) for syntax highlighting, and setting up [Prettier](https://prettier.io/docs/webstorm) for code formatting.
 
 ## Troubleshooting
 
@@ -189,7 +191,7 @@
     3. Reinstall the mint CLI: `npm install -g mint`
   </Accordion>
   <Accordion title="Issue: Encountering an unknown error">
     **Solution**: Go to the root of your device and delete the `~/.mintlify` folder. Afterwards, run `mint dev` again.
   </Accordion>
   <Accordion title="Error: permission denied">
     This is due to not having the required permissions to globally install node packages.
@@ -197,12 +199,12 @@
     **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.
   </Accordion>
   <Accordion title="The local preview doesn't look the same as my docs do on the web">
     This is likely due to an outdated version of the CLI.
 
    **Solution:** Run `mint update` to get the latest changes.
   </Accordion>
   <Accordion title="mintlify vs. mint package">
     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 don't use npm or don't see it in the -g list, try `which mint` to locate the installation.
 

organize/mintignore.mdx

@@ -1,10 +1,10 @@
 ---
 title: "Mintignore"
 description: "Exclude specific files and directories from your published documentation."
 keywords: ["exclude", "ignore", "gitignore", "drafts", "private"]
 ---
 
 The `.mintignore` file allows you to exclude specific files and directories from being processed and published to your documentation site.
 
 Use `.mintignore` to keep drafts, internal notes, and source files out of your public documentation while maintaining them in your repository.
 
@@ -31,6 +31,7 @@
 - Don't appear in your published documentation.
 - Aren't indexed for search.
 - Aren't accessible to visitors.
+- Are ignored by [broken link checks](/installation#find-broken-links). Links that point to ignored files are broken.
 
 ## Default ignored patterns
 
@@ -47,7 +48,7 @@
 
 <Note>
   Unlike [hidden pages](/organize/hidden-pages), files excluded by `.mintignore`
   are completely removed from your site and cannot be accessed by URL.
 </Note>
 
 ## Pattern syntax
@@ -60,4 +61,4 @@
 | `*.draft.mdx`      | Excludes all files ending in `.draft.mdx`      |
 | `private-notes.md` | Excludes a specific file                       |
 | `**/internal/**`   | Excludes any `internal` directory at any level |
 | `!important.mdx`   | Negates a previous pattern (includes the file) |