mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
d002a1491b
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
75 lines
2.4 KiB
Plaintext
75 lines
2.4 KiB
Plaintext
---
|
|
title: "从发布中排除文件"
|
|
sidebarTitle: "排除文件"
|
|
description: "使用 `.mintignore` 文件将特定文件和目录排除在已发布文档之外。"
|
|
keywords: ["排除", "忽略", "gitignore", "草稿", "私有"]
|
|
---
|
|
|
|
`.mintignore` 文件允许你将文档存储库中的特定文件和目录从处理和发布到文档站点的流程中排除。
|
|
|
|
使用 `.mintignore`，你可以在存储库中保留草稿、内部笔记和源文件的同时，将它们排除在公开文档之外。
|
|
|
|
<div id="create-a-mintignore-file">
|
|
## 创建 .mintignore 文件
|
|
</div>
|
|
|
|
在文档根目录下创建一个 `.mintignore` 文件。该文件使用与 `.gitignore` 相同的匹配模式语法。
|
|
|
|
```plaintext .mintignore
|
|
# 排除草稿文档
|
|
drafts/
|
|
*.draft.mdx
|
|
|
|
# 排除内部文档
|
|
internal/
|
|
|
|
# 排除特定文件
|
|
private-notes.md
|
|
```
|
|
|
|
当 Mintlify 构建你的文档时，它会读取 `.mintignore` 文件，并在处理时排除所有匹配的文件或目录。
|
|
|
|
被排除的文件：
|
|
|
|
* 不会出现在你发布的文档中。
|
|
* 不会被收录进搜索索引。
|
|
* 访问者无法访问。
|
|
* 会被[失效链接检查](/zh/installation#find-broken-links)忽略。指向被忽略文件的链接会被视为失效链接。
|
|
|
|
<div id="default-ignored-patterns">
|
|
## 默认忽略模式
|
|
</div>
|
|
|
|
Mintlify 会自动忽略以下目录和文件，无需任何配置：
|
|
|
|
* `.git`
|
|
* `.github`
|
|
* `.claude`
|
|
* `.agents`
|
|
* `.idea`
|
|
* `node_modules`
|
|
* `README.md`
|
|
* `LICENSE.md`
|
|
* `CHANGELOG.md`
|
|
* `CONTRIBUTING.md`
|
|
|
|
你不需要将这些目录添加到 `.mintignore` 文件中。
|
|
|
|
<Note>
|
|
与[隐藏页面](/zh/organize/hidden-pages)不同，由 `.mintignore`
|
|
排除的文件会从你的站点中完全移除，无法通过 URL 访问。
|
|
</Note>
|
|
|
|
<div id="pattern-syntax">
|
|
## 模式语法
|
|
</div>
|
|
|
|
`.mintignore` 文件遵循 `.gitignore` 的语法。常见的匹配模式包括：
|
|
|
|
| 模式 | 说明 |
|
|
| ------------------ | ---------------------------------------------- |
|
|
| `drafts/` | 排除整个 `drafts` 目录 |
|
|
| `*.draft.mdx` | 排除所有以 `.draft.mdx` 结尾的文件 |
|
|
| `private-notes.md` | 排除特定文件 |
|
|
| `**/internal/**` | 排除位于任意层级的任何 `internal` 目录 |
|
|
| `!important.mdx` | 否定前面的模式（改为包含该文件） | |