📚 使用帮助

🚀 快速开始

IPYNB.CN 让您能够快速查看和分享 Jupyter Notebook，无需安装任何软件。只需要一个浏览器，就能享受专业的 notebook 查看体验。

基本使用步骤

  1. 准备 Notebook URL - 确保您的 Notebook 是公开访问的
  2. 访问 IPYNB.CN - 在首页输入框中粘贴 URL
  3. 点击 Go! - 点击"Go!"按钮开始渲染
  4. 等待完成 - 等待渲染完成，即可查看您的 Notebook
  5. 分享链接 - 复制生成的链接分享给他人

📱 支持的平台

GitHub 仓库

支持 GitHub 仓库中的 .ipynb 文件，URL 格式：

https://github.com/用户名/仓库名/blob/分支名/文件路径.ipynb

示例： 直接复制 GitHub 上 notebook 文件的 URL 即可。

GitHub Gist

支持 Gist 中的 notebook 文件，URL 格式：

https://gist.github.com/用户名/gist_id

示例： 如果您的 Gist 包含 .ipynb 文件，直接使用 Gist 链接。

Hugging Face

支持 Hugging Face 模型和数据集中的 notebook，URL 格式：

https://huggingface.co/用户名/模型名/blob/main/example.ipynb

示例： 许多 HF 模型都包含示例 notebook，可以直接查看。

Dropbox

支持 Dropbox 公开分享的 .ipynb 文件。

注意： 确保文件是通过 Dropbox 公开分享的。

直接 URL

支持任何公开的 .ipynb 文件链接。

要求： URL 必须直接指向 .ipynb 文件且可公开访问。

💡 最佳实践

📝 Notebook 准备建议

  • 确保公开访问 - 检查您的 notebook 是否可以被公开访问
  • 保护敏感信息 - 避免在 notebook 中包含密码、API 密钥等敏感信息
  • 清晰的文档 - 使用 Markdown cell 添加清晰的说明和注释
  • 合理的结构 - 合理组织代码结构，便于他人阅读和理解
  • 控制输出大小 - 避免产生过大的输出，影响渲染性能

🎯 性能优化技巧

  • 清理输出 - 在分享前清除不必要的 cell 输出
  • 压缩图片 - 如果包含图片，适当压缩以提高加载速度
  • 分割长文件 - 将超长的 notebook 分割成多个部分
  • 使用相对路径 - 图片和数据文件使用相对路径引用

🔧 技术特性

渲染功能

  • 渲染引擎：基于 nbconvert 的最新版本
  • 语法高亮：支持 Python、R、Julia 等多种语言
  • 数学公式：完整的 MathJax 支持
  • 图表显示：支持 matplotlib、plotly、bokeh 等

用户体验

  • 响应式设计：完美适配移动设备
  • 暗色模式：保护视力的暗色主题
  • 快速加载：CDN 加速，全球快速访问
  • 搜索友好：SEO 优化，便于搜索发现

❓ 常见问题解决

🚫 渲染失败怎么办？

  • 检查 URL 格式：确保 URL 正确且包含 .ipynb 扩展名
  • 验证访问权限：确认文件是公开的，可以在浏览器中直接访问
  • 检查网络连接：确保网络连接正常
  • 等待重试：有时服务器繁忙，稍后重试即可

⚡ 渲染速度慢怎么办？

  • 检查文件大小：过大的 notebook 文件会影响渲染速度
  • 优化图片：压缩 notebook 中的图片以提高加载速度
  • 清理输出：清除不必要的 cell 输出
  • 分割文件：将大文件分割成多个小文件

🔐 隐私和安全

  • 数据安全：我们不存储您的 notebook 内容
  • 实时渲染：所有渲染都是实时进行的
  • 无缓存敏感信息：不会缓存任何敏感信息
  • HTTPS 保护：全站 HTTPS 加密传输

📞 获取帮助

🔗 相关链接

💬 反馈渠道

如果您遇到问题或有改进建议，欢迎通过以下方式联系我们：

  • 发送邮件到 support@ipynb.cn
  • 在 GitHub 上提交 Issue
  • 关注我们的更新公告