从发布中排除文件
使用带有 glob 模式的 .mintignore 文件将特定文件和目录排除在已发布文档之外,语法类似 .gitignore。
.mintignore 文件让你可以将文档存储库中的特定文件和目录从文档站点的处理和发布流程中排除。
使用 .mintignore,你可以在存储库中保留草稿、内部笔记和源文件的同时,将它们排除在公开文档之外。
在文档根目录下创建一个 .mintignore 文件。该文件使用与 .gitignore 相同的匹配模式语法。
# 排除草稿文档
drafts/
*.draft.mdx
# 排除内部文档
internal/
# 排除特定文件
private-notes.md当 Mintlify 构建你的文档时,它会读取 .mintignore 文件,并在处理时排除所有匹配的文件或目录。
被排除的文件:
- 不会出现在你发布的文档中。
- 不会被收录进搜索索引。
- 访问者无法访问。
- 不会触发失效链接检查。指向被忽略文件的链接会失效。
Mintlify 会自动忽略以下目录和文件,无需任何配置:
.git.github.claude.agents.idea.vscodenode_modulesbuilddistcoverage.cachetmptempREADME.mdLICENSE.mdCHANGELOG.mdCONTRIBUTING.md
你不需要将这些目录添加到 .mintignore 文件中。
与隐藏页面不同,.mintignore 会将匹配的文件从你的站点中完全移除。访问者无法通过 URL 访问这些文件。
.mintignore 文件遵循 .gitignore 的语法。常见的匹配模式包括:
| 模式 | 说明 |
|---|---|
drafts/ | 排除整个 drafts 目录 |
*.draft.mdx | 排除所有以 .draft.mdx 结尾的文件 |
private-notes.md | 排除特定文件 |
**/internal/** | 排除位于任意层级的任何 internal 目录 |
!important.mdx | 否定前面的模式 (改为包含该文件) |
Was this page helpful?Suggest editsRaise issue