ctrl+shift+p filters: :st2 :st3 :win :osx :linux
浏览

Ipynb Preview as Markdown

作者： valentinbarral 全部

Sublime Text 插件，用于预览 Markdown 格式的 .ipynb 文件。

标签 文本处理, 格式化

详细信息

  • 0.3.0
  • github.​com
  • github.​com
  • 5个月前
  • 58分钟前
  • 5个月前

安装次数

  • 总计 302
  • Win 154
  • Mac 89
  • Linux 59
8月6日 8月5日 8月4日 8月3日 8月2日 8月1日 7月31日 7月30日 7月29日 7月28日 7月27日 7月26日 7月25日 7月24日 7月23日 7月22日 7月21日 7月20日 7月19日 7月18日 7月17日 7月16日 7月15日 7月14日 7月13日 7月12日 7月11日 7月10日 7月9日 7月8日 7月7日 7月6日 7月5日 7月4日 7月3日 7月2日 7月1日 6月30日 6月29日 6月28日 6月27日 6月26日 6月25日 6月24日 6月23日
Windows 2 1 2 2 0 3 2 0 1 2 1 3 2 4 2 0 0 0 1 2 0 0 0 1 0 2 1 2 3 2 2 1 0 1 1 1 3 1 0 0 0 1 2 1 2
Mac 1 1 0 0 0 0 0 0 1 0 0 0 1 2 0 1 0 0 2 0 1 0 0 0 2 1 0 0 1 0 0 0 2 0 0 2 0 0 1 0 1 2 0 0 1
Linux 0 0 1 0 0 0 1 0 0 1 0 0 0 0 0 1 0 1 1 0 0 0 1 0 0 0 0 0 3 0 0 0 0 1 0 0 0 0 0 1 0 0 1 2 0

README

源代码
raw.​githubusercontent.​com

Ipynb Preview as Markdown

Ipynb Preview as Markdown 是一款适用于 Sublime Text 的插件，它允许用户在编辑器中直接查看 Markdown 格式的 .ipynb (Jupyter Notebook) 文件。此插件提供了一种便捷的方式，无需离开 Sublime Text 即可预览笔记本文件，并以可读的格式显示 Markdown、源代码和输出单元格。

功能

以下是此插件集成的功能概述

  • 选择性单元格排除：用户可以选择性排除最终 Markdown 文档中的特定单元格。这包括排除包含源代码的单元格，执行后显示输出的单元格，或者两者都排除。

  • 增强图片处理：为了解决笔记本中 Base64 编码图片的限制，此工具自动将这些图片转换成对临时文件的引用。这种方法不仅使文档更易于阅读，还便于操作和分享生成的 Markdown 文件。

  • Markdown 单元格中的绝对图片路径：对于包含对本地图片引用的 Markdown 单元格，此工具自动将原始路径替换为绝对路径。这种调整确保在使用文档转换插件（如 Pandoc）时，图片能被正确渲染。

  • 保留源代码单元格的语言：鉴于笔记本中可以使用的多种编程语言，此工具在转换为 Markdown 时保留笔记本中代码单元格指定的原始语言。这种保留源语言承诺确保在最终文档中保留语法高亮和其他特定语言的功能，从而实现从笔记本到 Markdown 格式的无缝转换。

安装

"Ipynb 预览为 Markdown" 可通过手动安装或在 Sublime Text 的便捷包管理器 Package Control 中进行安装。

选项 1：使用 Package Control 进行安装（推荐）

  1. 安装 Package Control：如果您尚未安装，请根据 安装说明 进行安装。
  2. 打开命令面板：在 Windows/Linux 上使用 Shift+Ctrl+P 或在 macOS 上使用 Cmd+Shift+P 打开命令面板。
  3. 安装包：输入 Package Control: Install Package 并按 Enter。
  4. 查找并安装：在列表中搜索“Ipynb 预览为 Markdown”并按 Enter 安装。
  5. 重启 Sublime Text：确保插件被正确加载。

选项 2：手动安装

  1. 下载插件：克隆此仓库或下载 ZIP 文件并解压。
  2. 定位 Sublime Text 包夹目录:
    • 在 Windows 上，路径通常是 C:\Users\<您的用户名>\AppData\Roaming\Sublime Text 3\Packages\
    • 在 macOS 上，路径通常是 /Users/<您的用户名>/Library/Application Support/Sublime Text 3/Packages/
    • 在 Linux 上，路径通常是 ~/.config/sublime-text-3/Packages/
  3. 安装插件：将插件目录（包含 ipynb_viewer.py 和 Default.sublime-commands 文件）复制到 Sublime Text 包夹目录。
  4. 重启 Sublime Text：这确保插件已加载并可使用。

使用方法

要使用 “Ipynb 预览为 Markdown” 插件：

  1. 在 Sublime Text 中打开一个 .ipynb 文件。
  2. 使用 Shift+Ctrl+P（或 macOS 上的 Cmd+Shift+P）打开命令面板。
  3. 输入 预览 ipynb 为 Markdown 并选中出现的命令。
  4. 将打开一个新的窗口，显示 Markdown 预览，其中包含所有类型的单元格（Markdown、源代码或结果）。预览为只读，不能编辑。
  5. 输入 预览 ipynb 为 Markdown（无输出） 以在预览中省略包含结果的单元格。
  6. 输入 预览 ipynb 为 Markdown（无代码） 以在预览中省略包含源代码的单元格。
  7. 输入 预览 ipynb 为 Markdown（无代码，无输出） 以在预览中仅显示 Markdown 单元格。

许可证

本项目许可协议为 MIT 许可协议 - 有关详细信息，请参阅 LICENSE 文件。

MIT License

Copyright (c) 2024 Valentin Barral

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.