From 8720fa2ad104f7cfd8bee556845daf6ff9ba9aa2 Mon Sep 17 00:00:00 2001 From: Kyle Finken Date: Tue, 25 Nov 2025 18:06:55 -0800 Subject: [PATCH 1/6] Add new doc for mintignore Add new doc for mintignore --- docs.json | 121 +++++++++------------------------------ organize/mint-ignore.mdx | 48 ++++++++++++++++ 2 files changed, 76 insertions(+), 93 deletions(-) create mode 100644 organize/mint-ignore.mdx diff --git a/docs.json b/docs.json index 60d91773a..f8e1dd489 100644 --- a/docs.json +++ b/docs.json @@ -40,7 +40,8 @@ "organize/settings", "organize/navigation", "organize/pages", - "organize/hidden-pages" + "organize/hidden-pages", + "organize/mint-ignore" ] }, { @@ -160,10 +161,7 @@ }, { "group": "Insights", - "pages": [ - "insights/overview", - "insights/feedback" - ] + "pages": ["insights/overview", "insights/feedback"] }, "optimize/seo", "optimize/pdf-exports", @@ -237,9 +235,7 @@ { "group": "API docs", "icon": "file-json", - "pages": [ - "guides/migrating-from-mdx" - ] + "pages": ["guides/migrating-from-mdx"] }, { "group": "Best practices", @@ -259,10 +255,7 @@ { "group": "Git", "icon": "git-merge", - "pages": [ - "guides/git-concepts", - "guides/branches" - ] + "pages": ["guides/git-concepts", "guides/branches"] } ] }, @@ -272,17 +265,12 @@ { "group": "API reference", "icon": "file-json", - "pages": [ - "api/introduction" - ] + "pages": ["api/introduction"] }, { "group": "Admin", "icon": "activity", - "pages": [ - "api/update/trigger", - "api/update/status" - ] + "pages": ["api/update/trigger", "api/update/status"] }, { "group": "Agent", @@ -309,9 +297,7 @@ { "group": "Changelog", "icon": "calendar", - "pages": [ - "changelog" - ] + "pages": ["changelog"] } ] } @@ -461,10 +447,7 @@ }, { "group": "Analyses", - "pages": [ - "fr/insights/overview", - "fr/insights/feedback" - ] + "pages": ["fr/insights/overview", "fr/insights/feedback"] }, "fr/optimize/seo", "fr/optimize/pdf-exports", @@ -538,9 +521,7 @@ { "group": "Documentation de l’API", "icon": "file-json", - "pages": [ - "fr/guides/migrating-from-mdx" - ] + "pages": ["fr/guides/migrating-from-mdx"] }, { "group": "Bonnes pratiques", @@ -560,10 +541,7 @@ { "group": "Git", "icon": "git-merge", - "pages": [ - "fr/guides/git-concepts", - "fr/guides/branches" - ] + "pages": ["fr/guides/git-concepts", "fr/guides/branches"] } ] }, @@ -573,17 +551,12 @@ { "group": "référence de l’API", "icon": "file-json", - "pages": [ - "fr/api/introduction" - ] + "pages": ["fr/api/introduction"] }, { "group": "Admin", "icon": "activity", - "pages": [ - "fr/api/update/trigger", - "fr/api/update/status" - ] + "pages": ["fr/api/update/trigger", "fr/api/update/status"] }, { "group": "Agent", @@ -610,9 +583,7 @@ { "group": "Journal des modifications", "icon": "calendar", - "pages": [ - "fr/changelog" - ] + "pages": ["fr/changelog"] } ] } @@ -762,10 +733,7 @@ }, { "group": "Información detallada", - "pages": [ - "es/insights/overview", - "es/insights/feedback" - ] + "pages": ["es/insights/overview", "es/insights/feedback"] }, "es/optimize/seo", "es/optimize/pdf-exports", @@ -839,9 +807,7 @@ { "group": "Documentación de la API", "icon": "file-json", - "pages": [ - "es/guides/migrating-from-mdx" - ] + "pages": ["es/guides/migrating-from-mdx"] }, { "group": "Mejores prácticas", @@ -861,10 +827,7 @@ { "group": "Git", "icon": "git-merge", - "pages": [ - "es/guides/git-concepts", - "es/guides/branches" - ] + "pages": ["es/guides/git-concepts", "es/guides/branches"] } ] }, @@ -874,17 +837,12 @@ { "group": "Referencia de la API", "icon": "file-json", - "pages": [ - "es/api/introduction" - ] + "pages": ["es/api/introduction"] }, { "group": "Administrador", "icon": "activity", - "pages": [ - "es/api/update/trigger", - "es/api/update/status" - ] + "pages": ["es/api/update/trigger", "es/api/update/status"] }, { "group": "Agente", @@ -911,9 +869,7 @@ { "group": "Cambios", "icon": "calendar", - "pages": [ - "es/changelog" - ] + "pages": ["es/changelog"] } ] } @@ -1063,10 +1019,7 @@ }, { "group": "洞察", - "pages": [ - "zh/insights/overview", - "zh/insights/feedback" - ] + "pages": ["zh/insights/overview", "zh/insights/feedback"] }, "zh/optimize/seo", "zh/optimize/pdf-exports", @@ -1140,9 +1093,7 @@ { "group": "API 文档", "icon": "file-json", - "pages": [ - "zh/guides/migrating-from-mdx" - ] + "pages": ["zh/guides/migrating-from-mdx"] }, { "group": "最佳实践", @@ -1162,10 +1113,7 @@ { "group": "Git", "icon": "git-merge", - "pages": [ - "zh/guides/git-concepts", - "zh/guides/branches" - ] + "pages": ["zh/guides/git-concepts", "zh/guides/branches"] } ] }, @@ -1175,17 +1123,12 @@ { "group": "API 参考", "icon": "file-json", - "pages": [ - "zh/api/introduction" - ] + "pages": ["zh/api/introduction"] }, { "group": "管理员", "icon": "activity", - "pages": [ - "zh/api/update/trigger", - "zh/api/update/status" - ] + "pages": ["zh/api/update/trigger", "zh/api/update/status"] }, { "group": "代理", @@ -1212,9 +1155,7 @@ { "group": "更新日志", "icon": "calendar", - "pages": [ - "zh/changelog" - ] + "pages": ["zh/changelog"] } ] } @@ -1331,13 +1272,7 @@ "background": "/images/thumbnail/background.svg" }, "contextual": { - "options": [ - "copy", - "chatgpt", - "claude", - "cursor", - "vscode" - ] + "options": ["copy", "chatgpt", "claude", "cursor", "vscode"] }, "redirects": [ { @@ -1722,4 +1657,4 @@ "twitter:site": "@mintlify" } } -} \ No newline at end of file +} diff --git a/organize/mint-ignore.mdx b/organize/mint-ignore.mdx new file mode 100644 index 000000000..80222c041 --- /dev/null +++ b/organize/mint-ignore.mdx @@ -0,0 +1,48 @@ +--- +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. + +## Creating a .mintignore file + +Create a `.mintignore` file in the root of your docs directory. This file uses the same pattern syntax as `.gitignore`, making it familiar and easy to configure. + +```plaintext .mintignore +# Exclude draft documents +drafts/ +*.draft.mdx + +# Exclude internal documentation +internal/ + +# Exclude specific files +private-notes.md +``` + +When Mintlify builds your documentation, it reads the `.mintignore` file and excludes any matching files or directories from processing. Excluded files: + +- Won't appear in your published documentation +- Won't be indexed for search +- Won't be accessible to visitors + + + Unlike [hidden pages](/organize/hidden-pages), files excluded by `.mintignore` + are completely removed from your site and cannot be accessed by URL. + + +## Pattern syntax + +The `.mintignore` file follows `.gitignore` syntax. Here are common patterns: + +| Pattern | Description | +| ------------------ | ---------------------------------------------- | +| `drafts/` | Excludes the entire `drafts` directory | +| `*.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) | From dc9631b09c426e87eec9e957988cecfdff2579dc Mon Sep 17 00:00:00 2001 From: Kyle Finken Date: Tue, 25 Nov 2025 18:34:51 -0800 Subject: [PATCH 2/6] revert docs.json title --- docs.json | 121 +++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 93 insertions(+), 28 deletions(-) diff --git a/docs.json b/docs.json index f8e1dd489..60d91773a 100644 --- a/docs.json +++ b/docs.json @@ -40,8 +40,7 @@ "organize/settings", "organize/navigation", "organize/pages", - "organize/hidden-pages", - "organize/mint-ignore" + "organize/hidden-pages" ] }, { @@ -161,7 +160,10 @@ }, { "group": "Insights", - "pages": ["insights/overview", "insights/feedback"] + "pages": [ + "insights/overview", + "insights/feedback" + ] }, "optimize/seo", "optimize/pdf-exports", @@ -235,7 +237,9 @@ { "group": "API docs", "icon": "file-json", - "pages": ["guides/migrating-from-mdx"] + "pages": [ + "guides/migrating-from-mdx" + ] }, { "group": "Best practices", @@ -255,7 +259,10 @@ { "group": "Git", "icon": "git-merge", - "pages": ["guides/git-concepts", "guides/branches"] + "pages": [ + "guides/git-concepts", + "guides/branches" + ] } ] }, @@ -265,12 +272,17 @@ { "group": "API reference", "icon": "file-json", - "pages": ["api/introduction"] + "pages": [ + "api/introduction" + ] }, { "group": "Admin", "icon": "activity", - "pages": ["api/update/trigger", "api/update/status"] + "pages": [ + "api/update/trigger", + "api/update/status" + ] }, { "group": "Agent", @@ -297,7 +309,9 @@ { "group": "Changelog", "icon": "calendar", - "pages": ["changelog"] + "pages": [ + "changelog" + ] } ] } @@ -447,7 +461,10 @@ }, { "group": "Analyses", - "pages": ["fr/insights/overview", "fr/insights/feedback"] + "pages": [ + "fr/insights/overview", + "fr/insights/feedback" + ] }, "fr/optimize/seo", "fr/optimize/pdf-exports", @@ -521,7 +538,9 @@ { "group": "Documentation de l’API", "icon": "file-json", - "pages": ["fr/guides/migrating-from-mdx"] + "pages": [ + "fr/guides/migrating-from-mdx" + ] }, { "group": "Bonnes pratiques", @@ -541,7 +560,10 @@ { "group": "Git", "icon": "git-merge", - "pages": ["fr/guides/git-concepts", "fr/guides/branches"] + "pages": [ + "fr/guides/git-concepts", + "fr/guides/branches" + ] } ] }, @@ -551,12 +573,17 @@ { "group": "référence de l’API", "icon": "file-json", - "pages": ["fr/api/introduction"] + "pages": [ + "fr/api/introduction" + ] }, { "group": "Admin", "icon": "activity", - "pages": ["fr/api/update/trigger", "fr/api/update/status"] + "pages": [ + "fr/api/update/trigger", + "fr/api/update/status" + ] }, { "group": "Agent", @@ -583,7 +610,9 @@ { "group": "Journal des modifications", "icon": "calendar", - "pages": ["fr/changelog"] + "pages": [ + "fr/changelog" + ] } ] } @@ -733,7 +762,10 @@ }, { "group": "Información detallada", - "pages": ["es/insights/overview", "es/insights/feedback"] + "pages": [ + "es/insights/overview", + "es/insights/feedback" + ] }, "es/optimize/seo", "es/optimize/pdf-exports", @@ -807,7 +839,9 @@ { "group": "Documentación de la API", "icon": "file-json", - "pages": ["es/guides/migrating-from-mdx"] + "pages": [ + "es/guides/migrating-from-mdx" + ] }, { "group": "Mejores prácticas", @@ -827,7 +861,10 @@ { "group": "Git", "icon": "git-merge", - "pages": ["es/guides/git-concepts", "es/guides/branches"] + "pages": [ + "es/guides/git-concepts", + "es/guides/branches" + ] } ] }, @@ -837,12 +874,17 @@ { "group": "Referencia de la API", "icon": "file-json", - "pages": ["es/api/introduction"] + "pages": [ + "es/api/introduction" + ] }, { "group": "Administrador", "icon": "activity", - "pages": ["es/api/update/trigger", "es/api/update/status"] + "pages": [ + "es/api/update/trigger", + "es/api/update/status" + ] }, { "group": "Agente", @@ -869,7 +911,9 @@ { "group": "Cambios", "icon": "calendar", - "pages": ["es/changelog"] + "pages": [ + "es/changelog" + ] } ] } @@ -1019,7 +1063,10 @@ }, { "group": "洞察", - "pages": ["zh/insights/overview", "zh/insights/feedback"] + "pages": [ + "zh/insights/overview", + "zh/insights/feedback" + ] }, "zh/optimize/seo", "zh/optimize/pdf-exports", @@ -1093,7 +1140,9 @@ { "group": "API 文档", "icon": "file-json", - "pages": ["zh/guides/migrating-from-mdx"] + "pages": [ + "zh/guides/migrating-from-mdx" + ] }, { "group": "最佳实践", @@ -1113,7 +1162,10 @@ { "group": "Git", "icon": "git-merge", - "pages": ["zh/guides/git-concepts", "zh/guides/branches"] + "pages": [ + "zh/guides/git-concepts", + "zh/guides/branches" + ] } ] }, @@ -1123,12 +1175,17 @@ { "group": "API 参考", "icon": "file-json", - "pages": ["zh/api/introduction"] + "pages": [ + "zh/api/introduction" + ] }, { "group": "管理员", "icon": "activity", - "pages": ["zh/api/update/trigger", "zh/api/update/status"] + "pages": [ + "zh/api/update/trigger", + "zh/api/update/status" + ] }, { "group": "代理", @@ -1155,7 +1212,9 @@ { "group": "更新日志", "icon": "calendar", - "pages": ["zh/changelog"] + "pages": [ + "zh/changelog" + ] } ] } @@ -1272,7 +1331,13 @@ "background": "/images/thumbnail/background.svg" }, "contextual": { - "options": ["copy", "chatgpt", "claude", "cursor", "vscode"] + "options": [ + "copy", + "chatgpt", + "claude", + "cursor", + "vscode" + ] }, "redirects": [ { @@ -1657,4 +1722,4 @@ "twitter:site": "@mintlify" } } -} +} \ No newline at end of file From 64523b020f8e7ce7bc2de8dc02f49eaaedcc2b8c Mon Sep 17 00:00:00 2001 From: Kyle Finken Date: Tue, 25 Nov 2025 18:35:13 -0800 Subject: [PATCH 3/6] Add mintignore to docs.json title --- docs.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs.json b/docs.json index 60d91773a..b343a7d72 100644 --- a/docs.json +++ b/docs.json @@ -40,7 +40,8 @@ "organize/settings", "organize/navigation", "organize/pages", - "organize/hidden-pages" + "organize/hidden-pages", + "organize/mint-ignore" ] }, { From c7b5339d687f4a364398e59e064792562339339d Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 25 Nov 2025 19:02:31 -0800 Subject: [PATCH 4/6] rename to match file name and title --- organize/{mint-ignore.mdx => mintignore.mdx} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename organize/{mint-ignore.mdx => mintignore.mdx} (100%) diff --git a/organize/mint-ignore.mdx b/organize/mintignore.mdx similarity index 100% rename from organize/mint-ignore.mdx rename to organize/mintignore.mdx From 42bc88dfa253fcbd381c272b95b53f1c91a1e0b2 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 25 Nov 2025 19:04:31 -0800 Subject: [PATCH 5/6] Update docs.json --- docs.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs.json b/docs.json index b343a7d72..e368f6a4f 100644 --- a/docs.json +++ b/docs.json @@ -41,7 +41,7 @@ "organize/navigation", "organize/pages", "organize/hidden-pages", - "organize/mint-ignore" + "organize/mintignore" ] }, { From c9198a5acb27f6a7a3e9b86f9ae2a8484199d62f Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 25 Nov 2025 19:12:22 -0800 Subject: [PATCH 6/6] copyedit --- organize/mintignore.mdx | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/organize/mintignore.mdx b/organize/mintignore.mdx index 80222c041..ff095ab6b 100644 --- a/organize/mintignore.mdx +++ b/organize/mintignore.mdx @@ -8,9 +8,9 @@ The `.mintignore` file allows you to exclude specific files and directories from Use `.mintignore` to keep drafts, internal notes, and source files out of your public documentation while maintaining them in your repository. -## Creating a .mintignore file +## Create a .mintignore file -Create a `.mintignore` file in the root of your docs directory. This file uses the same pattern syntax as `.gitignore`, making it familiar and easy to configure. +Create a `.mintignore` file in the root of your docs directory. This file uses the same pattern syntax as `.gitignore`. ```plaintext .mintignore # Exclude draft documents @@ -24,20 +24,20 @@ internal/ private-notes.md ``` -When Mintlify builds your documentation, it reads the `.mintignore` file and excludes any matching files or directories from processing. Excluded files: +When Mintlify builds your documentation, it reads the `.mintignore` file and excludes any matching files or directories from processing. -- Won't appear in your published documentation -- Won't be indexed for search -- Won't be accessible to visitors +Excluded files: +- Don't appear in your published documentation. +- Aren't indexed for search. +- Aren't accessible to visitors. - Unlike [hidden pages](/organize/hidden-pages), files excluded by `.mintignore` - are completely removed from your site and cannot be accessed by URL. + Unlike [hidden pages](/organize/hidden-pages), files excluded by `.mintignore` are completely removed from your site and cannot be accessed by URL. ## Pattern syntax -The `.mintignore` file follows `.gitignore` syntax. Here are common patterns: +The `.mintignore` file follows `.gitignore` syntax. Some common patterns include: | Pattern | Description | | ------------------ | ---------------------------------------------- |