如何以只读模式打开Jupyter Notebook？解决Git协作冲突

1. 启动Jupyter时开启只读模式 #

• 针对传统Jupyter Notebook，启动时添加--read-only参数：

  jupyter notebook --read-only
  

  用这个命令打开的Notebook只能查看，不会保存任何内容或元数据的变更。
• JupyterLab同样支持该参数：

  jupyter lab --read-only
  

2. 转换为静态格式查看 #

把Notebook转成完全静态的HTML或PDF，无需启动Jupyter环境，彻底避免元数据问题：

• 转换为HTML：

  jupyter nbconvert --to html your_notebook.ipynb
  

• 转换为PDF：

  jupyter nbconvert --to pdf your_notebook.ipynb
  

  生成的文件直接用浏览器或PDF阅读器打开即可。

3. 专用工具只读查看 #

• nbdime：安装后用网页版只读查看器打开Notebook，完全不会修改原文件：

  nbdiff-web --readonly your_notebook.ipynb
  

• VS Code只读模式：在VS Code中打开Notebook后，点击右上角的锁定图标切换为只读状态，不会触发元数据自动保存。

4. Git层面过滤元数据差异 #

如果偶尔误操作导致元数据变更，可以在Git中配置过滤器，自动忽略易变的元数据：

1. 编写一个简单的Python脚本（比如strip_notebook_meta.py），移除Notebook中的kernelspec、execution_count等易变字段。
2. 在Git配置中添加过滤器：

   [filter "strip-notebook-meta"]
       clean = python strip_notebook_meta.py
       smudge = cat
   

3. 在仓库的.gitattributes文件中添加规则：

   *.ipynb filter=strip-notebook-meta
   

   这样Git提交时会自动过滤掉元数据，避免不必要的差异和冲突。

内容的提问来源于stack exchange，提问作者Caleb