📚 使用教程

十篇实用教程,带你快速掌握 IPYNB.CN 的所有功能

从基础操作到高级技巧,让你成为 Jupyter Notebook 分享专家

教程 1

快速入门:如何在 IPYNB.CN 上查看你的第一个 Notebook

从零开始,学会使用 IPYNB.CN 查看 Jupyter Notebook

入门级
1
准备 Notebook 链接
找到你想要查看的 Jupyter Notebook 文件,确保它是公开可访问的。可以是 GitHub 上的 .ipynb 文件、Gist 或者其他公开链接。
2
访问 IPYNB.CN
在浏览器中打开 ipynb.cn,你会看到一个简洁的首页界面,中央有一个输入框。
3
粘贴链接
将你的 Notebook 链接复制并粘贴到输入框中。支持完整 URL 或简化格式(如 GitHub 用户名/仓库名)。
4
开始查看
点击 "Go!" 按钮,等待几秒钟让系统渲染你的 Notebook,然后就可以在线查看了!
小提示

如果是第一次访问某个 Notebook,可能需要稍等片刻。IPYNB.CN 会缓存渲染结果,下次访问会更快。

基础操作 快速入门 新手必读
教程 2

GitHub 集成:无缝查看 GitHub 仓库中的 Notebook

掌握各种 GitHub 链接格式,轻松分享你的项目

入门级
1
完整 GitHub URL
使用完整的 GitHub 文件链接,格式如下:
https://github.com/用户名/仓库名/blob/分支名/路径/文件名.ipynb
2
简化 GitHub 格式
IPYNB.CN 支持简化格式,直接输入:
用户名/仓库名
系统会自动查找仓库中的 Notebook 文件。
3
指定文件路径
如果 Notebook 在子目录中,可以使用:
用户名/仓库名/blob/main/notebooks/example.ipynb
4
浏览整个仓库
输入仓库名后,可以浏览整个仓库的文件结构,点击任意 .ipynb 文件查看。
注意事项

确保 GitHub 仓库是公开的,私有仓库无法通过 IPYNB.CN 访问。

GitHub 仓库浏览 版本控制
教程 3

GitHub Gist:快速分享单个 Notebook 文件

学会使用 Gist 快速分享和查看单个 Notebook

入门级
1
创建 Gist
在 GitHub 上访问 gist.github.com,上传你的 .ipynb 文件创建一个新的 Gist。
2
获取 Gist 链接
复制 Gist 的 URL,格式通常为:
https://gist.github.com/用户名/gist_id
3
在 IPYNB.CN 中查看
将 Gist 链接粘贴到 IPYNB.CN 的输入框中,点击 Go! 即可查看。
4
支持多文件 Gist
如果 Gist 包含多个文件,IPYNB.CN 会显示文件列表,让你选择要查看的 Notebook。
使用场景

Gist 特别适合分享代码片段、小型示例或快速原型。比完整仓库更轻量,更适合临时分享。

Gist 快速分享 代码片段
教程 4

Hugging Face 支持:查看 AI 模型的示例 Notebook

探索 Hugging Face 平台上丰富的机器学习示例

进阶级
1
找到 Hugging Face 模型
huggingface.co 上浏览模型,许多模型都包含示例 Notebook。
2
复制 Notebook 链接
点击模型页面上的 Notebook 文件,复制其 URL:
https://huggingface.co/组织名/模型名/blob/main/example.ipynb
3
在 IPYNB.CN 中渲染
将链接粘贴到 IPYNB.CN,查看完整的模型使用示例,包括代码、输出和可视化。
4
学习最佳实践
通过这些官方示例学习模型的正确使用方法、参数配置和最佳实践。
推荐模型

推荐查看 transformers、diffusers 等热门模型的示例,它们通常包含高质量的教程 Notebook。

Hugging Face 机器学习 AI 模型
教程 5

直接 URL:查看任意公开的 Notebook 文件

支持任何平台的公开 Notebook 文件链接

进阶级
1
确认文件可访问
确保 .ipynb 文件的 URL 是公开可访问的,可以直接在浏览器中下载。
2
支持的链接类型
支持各种直接文件链接:
https://example.com/notebook.ipynb https://cdn.example.com/files/analysis.ipynb https://www.dropbox.com/s/xxx/notebook.ipynb?dl=1
3
处理特殊 URL
对于 Dropbox 等服务,确保链接末尾包含 ?dl=1 参数以直接下载文件。
4
测试和验证
如果渲染失败,先在浏览器中直接访问链接,确认能正常下载 .ipynb 文件。
常见问题

有些云存储服务的分享链接不是直接文件链接,需要转换为直接下载链接才能使用。

直接链接 云存储 URL 处理
教程 6

暗色模式:优化夜间阅读体验

学会使用暗色模式,保护视力,提升阅读舒适度

入门级
1
找到暗色模式开关
在页面右上角导航栏中,找到月亮图标的按钮,这就是暗色模式开关。
2
切换模式
点击图标可以在亮色和暗色模式间切换。图标会根据当前模式变化(月亮/太阳)。
3
自动跟随系统
首次访问时会自动跟随系统设置。如果系统设置为暗色模式,网站也会默认使用暗色模式。
4
记忆用户偏好
你的模式选择会被保存,下次访问时会自动应用你喜欢的模式。
使用建议

暗色模式特别适合夜间使用或长时间阅读,可以有效减少眼部疲劳。代码高亮在暗色模式下也更加清晰。

暗色模式 用户体验 视力保护
教程 7

移动端优化:在手机上舒适查看 Notebook

掌握移动端的操作技巧,随时随地查看和分享

入门级
1
响应式设计
IPYNB.CN 采用响应式设计,自动适配各种屏幕尺寸,在手机、平板上都有良好体验。
2
触屏操作
支持触屏滑动、双指缩放等手势,可以方便地浏览长 Notebook 或查看详细图表。
3
导航优化
移动端导航会自动折叠,点击汉堡菜单可以展开所有导航选项。
4
分享功能
可以直接使用浏览器的分享功能,将 Notebook 链接分享到微信、QQ 等社交平台。
移动端技巧

建议在移动端使用暗色模式,更加省电且眼睛更舒适。长按链接可以直接复制分享。

移动端 响应式 触屏操作
教程 8

性能优化:让大型 Notebook 加载更快

学会优化 Notebook 性能,提升查看体验

高级
1
清理 Notebook 输出
在分享前清理不必要的输出内容,特别是大型图片和数据表格,可以显著减少文件大小。
2
优化图片大小
压缩 Notebook 中的图片,使用适当的分辨率和格式,减少加载时间。
3
利用缓存机制
IPYNB.CN 会缓存渲染结果。如果需要立即看到更新,可以在 URL 后添加 ?flush_cache=true
4
分割大型 Notebook
考虑将特别大的 Notebook 分割成多个小文件,提高加载速度和用户体验。
最佳实践

建议单个 Notebook 文件大小不超过 10MB,这样可以保证在各种网络环境下都有良好的加载体验。

性能优化 缓存管理 文件大小
教程 9

故障排除:解决常见的渲染问题

遇到问题不要慌,学会自己诊断和解决问题

进阶级
1
检查链接有效性
首先确认 Notebook 链接是否正确,可以直接在浏览器中访问链接测试。
2
常见错误处理
404 错误:链接无效或文件不存在
403 错误:权限问题,文件不是公开的
500 错误:服务器问题,稍后重试
3
清除缓存重试
如果看到的是旧版本,在 URL 后添加 ?flush_cache=true 强制刷新。
4
联系技术支持
如果问题持续存在,可以通过 FAQ 页面或邮件联系技术支持团队。
预防措施

在分享前最好自己先测试一下链接,确保文件可以正常访问和渲染。

故障排除 错误诊断 技术支持
教程 10

高级技巧:成为 IPYNB.CN 专家用户

掌握高级功能和技巧,充分发挥平台潜力

高级
1
URL 参数控制
使用特殊参数控制渲染行为:
?flush_cache=true # 强制刷新缓存 ?download=true # 直接下载文件 ?print=true # 打印友好格式
2
嵌入到网站
可以使用 iframe 将 IPYNB.CN 渲染的 Notebook 嵌入到你的网站中:
<iframe src="https://ipynb.cn/github/用户名/仓库名/blob/main/notebook.ipynb" width="100%" height="600"></iframe>
3
批量处理链接
为团队或课程创建标准化的链接格式,方便批量生成和管理多个 Notebook 链接。
4
API 集成
虽然没有官方 API,但可以通过 URL 规律进行程序化集成,构建自动化工作流。
专家提示

结合 GitHub Actions 或其他 CI/CD 工具,可以自动生成和更新 Notebook 的分享链接。

高级技巧 自动化 网站集成

🎉 恭喜!你已掌握所有技能

通过这十篇教程,你已经成为 IPYNB.CN 的专家用户

基础技能

掌握所有基本操作

进阶技巧

学会性能优化和故障排除

专家级别

掌握高级功能和集成技巧