跳转至

5.关于 gitignore

.gitignore 文件规则

  • 一行一项
  • 文件写完整文件名
  • 文件夹写 文件夹名/

忽略上传的几种方式:

  • 项目通用忽略 (Standard .gitignore)

    • 项目根目录添加 .gitignore 文件
    • .gitignore 文件会被上传
  • 文件夹级忽略 (Nested .gitignore)

    • 文件夹内添加 .gitignore 文件,内容为 *
    • 此文件夹会被忽略,vscode 文件树中显示为灰色
    • uv enve 自动采取这种方式
  • 个人/本地忽略 (Local Exclude)
    • 编辑项目下的 .git/info/exclude 文件,写法和 .gitignore 一样
    • .git 文件夹被强制忽略,所以此方式只在当前电脑生效
  • 全局忽略 (Global Ignore)
    • 任意位置创建 ~/.gitignore\_global
    • 使其生效:git config --global core.excludesfile ~/.gitignore_global

Note

  • git check-ignore -v 文件路径 :哪个文件、第几行规则导致了这个文件被忽略
  • 添加了忽略规则,但文件还是被上传了
  • 该文件 已经被 Git 追踪(Tracked) 过了,.gitignore 只能忽略 未被追踪(Untracked) 的文件。如果文件以前提交过,Git 会继续追踪它的变化,忽略规则无效。
  • 解决办法(清理缓存):
      1. 从 Git 记录中移除(保留本地文件) git rm -r --cached .venv/
      1. 重新提交(这次忽略规则就会生效了) git commit -m "Stop tracking .venv"

  • !!! note (MkDocs)靠缩进结束。一旦顶格写字,框就断了。

  • ::: note / /// note靠闭合符号结束。就像写代码块一样,要有始有终。

  • > [!NOTE] (GitHub)靠 > 符号结束。一旦哪一行前面没有 >,引用块就断了。