Skip to content

yechao-22951/vscode-plugin-embed-images-to-markdown

Repository files navigation

Markdown图片内嵌插件

把Markdown文件里引用的本地图片文件,以Data-URI的形式内嵌到Markdown内部,方便分发。
图片会自动调整格式和尺寸(JPG, 80%, Width<=600px)。
使用该插件产生的图片Data-URI数据块可以被折叠,尽量不影响再编辑时的体验。

内部

  • 目标图片锚点搜索
    使用正则表达式 /\!\[(.*)\]\((.+)\)/g,在文档文本中搜索,可能会产生歧义。

  • Data-URI生成
    Data-URI会被放到文件尾部。格式为:[embeded-image-{MD5}]: \r\n data:image ...
    所以一个图片数据块由两行组成。

  • Data-URI块折叠
    使用 /\[embeded-image-\w+\]:\sdata:image\//g 搜索文本内容,可能产生歧义。
    折叠长度为两行。

安装

  1. 在 Releases 中下载 .vsix 包。
  2. 打开vscode并转到扩展管理,点击右上角的···按钮打开菜单。
  3. 在菜单中选择Install from VSIX...
  4. 在文件框中选择下载的 .vsix 包即可。

使用

  1. F1命令面板:Embed Images To Markdown
  2. 文本编辑区右键菜单,选择Embed Images To Markdown
  3. 快捷键:Ctrl+Alt+E

成功后会生成 {filename}.idp.md 文件,并在窗口中打开。


Embed Images To Markdown README

Embed Images To Markdown is a command to embeded all referenced local image files to Markdown file with Data-URI, and folds image Data-URI blocks.

You can work with Markdown image paste extensions to paste images and then use Embed Images To Markdown to embed them.

Features

  • Find image anchors:
    Search image anchors by /\!\[(.*)\]\((.+)\)/g
  • Generate image Data-URI block:
    [embeded-image-{MD5}]: \r\n data:image ...
  • Image Data-URI blocks can be fold:
    Search blocks by /\[embeded-image-\w+\]:\sdata:image\//g

Working with Markdown

  • Open or create a Markdown file.

  • Paste images from clipboard and the image anchor looks like this: ![][embeded-image-7b60b17eeb06bf839c20a42de8953794].

  • Press Ctrl+Alt+E or Cmd+Alt+E to embed images to markdown file.

  • Also you can right-click on editor to open menu and click Embed Images To Markdown to use it.

  • The vscode command it Embed Images To Markdown.

For more information

Enjoy!

About

vscode-plugin-embed-images-to-markdown

Resources

Stars

Watchers

Forks

Packages

No packages published