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

Markdown 代码打包器

motine ST3

在不打扰的情况下将源代码文件包含在 markdown笔记中(Sublime Text 3 插件)

标签 markdown

详细信息

  • 0.1.0
  • github.com
  • github.com
  • 4年前
  • 56分钟前
  • 4年前

安装量

  • Total 628
  • Win 331
  • Mac 182
  • Linux 115
Aug 6 Aug 5 Aug 4 Aug 3 Aug 2 Aug 1 Jul 31 Jul 30 Jul 29 Jul 28 Jul 27 Jul 26 Jul 25 Jul 24 Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6 Jul 5 Jul 4 Jul 3 Jul 2 Jul 1 Jun 30 Jun 29 Jun 28 Jun 27 Jun 26 Jun 25 Jun 24 Jun 23
Windows 0 0 1 0 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1 0 0 1 0 0 0 1 0 0 0 0 0 1 0 0 0 2 0 0 0 0 0
Mac 1 1 0 0 0 0 0 0 1 0 0 0 1 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

读我

源代码
raw.githubusercontent.com

Markdown 代码打包器

将代码和文件打包成 markdown 文档。此 Sublime 3 插件将代码块转换为压缩的单行注释以提高可读性。

动机

为了个人笔记和笔记共享,我经常想把项目的所有代码保存在我的 Markdown 文档中。但是太多的代码块会打断阅读流程,并且没有方法可以提取所有文件。此插件允许在文档中对代码块/文件进行打包和解包。

示例

  • 展示一个 技术高峰,同时保留所需的但令人厌烦的配置文件
  • 包含一个长CSV表格,你想作为参考发送
  • 将一组文件存档为一个项目的起始模板
  • 在你的笔记中包含一个小资产,这样你就不必将其作为附加文件保存
  • 存档外部博客文章的内容,而不会使您的文档过载

到目前为止,我通过创建一个 gist、将文件放入一个 assets/ 文件夹或者把整个文档及其文件都压缩成zip来解决这些用例。此插件消除了这些需求。

之前

uncompressed code block

之后

packed content

功能

  • Markdown Code Packer: Pack:打包选定的代码块
  • Markdown Code Packer: Unpack:解包选定的代码块
  • Markdown Code Packer: Extract Selection to Folder:将选定的块提取到文件夹中(文件名可以包括相对路径)
  • Markdown Code Packer: Extract All to Folder:将文档中的所有块提取到文件夹中
  • Markdown Code Packer: Pack Folder:将文件夹中的所有文件插入到文档中

您还可以包含二进制文件(例如图像)

打包/解包

提取全部到文件夹

打包文件夹

演示文档

  • 测试
  • 我的Mac配置:包括打包的配置文件
  • Webpack:包括小型项目,务必选择一个,然后将其提取到一个文件夹中

安装

  • 使用Package Control:打开命令面板,运行Package Control: 安装包命令,查找并安装Markdown代码打包器插件。
  • 手动:将git仓库克隆或下载到您的包文件夹中(要找到文件夹,请运行命令首选项 - 浏览包)。

如果您想知道[[202003271748]]代表什么:这些是对其他笔记的引用(更多信息请见Sublime ZK)。

格式

未打包格式

`optional_filename`:

```optional_type
// code

```

打包格式

对于打包,我选择了deflate然后是base64(更多信息请见[assets/FormatChoice.md])。

贡献

如果您发现bug或修复了bug,请提交问题或创建拉取请求。直接联系,请访问我的tomrothe.de上的邮箱。

待办事项

  • 使用functools.partial (MarkdownCodePacker.py#L37)
  • 使用从extract_variables获取的file_path变量
  • VSCode插件?
  • 命令行工具(带有brew公式)?
  • 记住/推断带边框代码块的文件类型