Jupyter Notebooks .gitignore 模板详解

JupyterNotebooks.gitignore 是模板仓库 community 目录中的一个简短模板，只处理 Jupyter 和 IPython 在笔记本旁边生成的文件。它不包含虚拟环境和 __pycache__，因此要与 Python 模板一起使用。

保存在笔记本文件(.ipynb)内部的运行结果和图片不是 gitignore 的处理对象。这不是文件层面的问题，而是文件内容的问题，需要用其他工具处理。

逐条规则详解

模式	忽略什么，为什么忽略
.ipynb_checkpoints*/.ipynb_checkpoints/*	检查点Jupyter 自动保存时在每个笔记本所在目录中生成的副本。第一行匹配任意深度的检查点目录，第二行明确匹配下一级目录中的内容。
profile_default/ipython_config.py	IPython 设置IPython 配置文件目录和设置文件，其中可能包含运行历史数据库之类的个人信息。
.virtual_documents/	JupyterLab LSPjupyterlab-lsp 扩展为了把笔记本传给语言服务器而生成的虚拟文档目录。

实践中的注意事项

• 如果不想提交笔记本输出，可以把 nbstripout 安装为 git 过滤器，或养成提交前清除输出的习惯。
• 此模板不会拦截大型数据文件(data/、*.csv、*.parquet)。需要时请自行添加，或使用 DVC、Git LFS。
• 如果把 API 密钥放在 .env 中并在笔记本里读取，还需要 Python 模板中的 .env 规则。

原始模板

# gitignore template for Jupyter Notebooks# website: http://jupyter.org/.ipynb_checkpoints*/.ipynb_checkpoints/*# IPythonprofile_default/ipython_config.py# Jupyter lab virtual documents# https://jupyterlab-lsp.readthedocs.io/en/2.x/Configuring.html#virtual_documents_dir.virtual_documents/# Remove previous ipynb_checkpoints#   git rm -r .ipynb_checkpoints/

常搭配使用的模板