Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion organize/mintignore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
keywords: ["exclude", "ignore", "gitignore", "drafts", "private"]
---

The `.mintignore` file allows you to exclude specific files and directories in your documentation repository from being processed and published to your documentation site.

Check warning on line 8 in organize/mintignore.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/mintignore.mdx#L8

In general, use active voice instead of passive voice ('being processed').

Use `.mintignore` to keep drafts, internal notes, and source files out of your public documentation while maintaining them in your repository.

Expand All @@ -32,24 +32,28 @@
- 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.

Check warning on line 35 in organize/mintignore.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/mintignore.mdx#L35

In general, use active voice instead of passive voice ('Are ignored').

Check warning on line 35 in organize/mintignore.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/mintignore.mdx#L35

In general, use active voice instead of passive voice ('are broken').

## Default ignored patterns

Mintlify automatically ignores the following directories without requiring any configuration:
Mintlify automatically ignores the following directories and files without requiring any configuration:

- `.git`
- `.github`
- `.claude`
- `.agents`
- `.idea`
- `node_modules`
- `README.md`
- `LICENSE.md`
- `CHANGELOG.md`
- `CONTRIBUTING.md`

You don't need to add these to your `.mintignore` file.

<Note>
Unlike [hidden pages](/organize/hidden-pages), files excluded by `.mintignore`
are completely removed from your site and cannot be accessed by URL.

Check warning on line 56 in organize/mintignore.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/mintignore.mdx#L56

Use 'can't' instead of 'cannot'.

Check warning on line 56 in organize/mintignore.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/mintignore.mdx#L56

In general, use active voice instead of passive voice ('be accessed').
</Note>

## Pattern syntax
Expand All @@ -62,4 +66,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) |

Check warning on line 69 in organize/mintignore.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/mintignore.mdx#L69

Use parentheses judiciously.