优秀的编程知识分享平台

网站首页 > 技术文章 正文

Visual Studio Code 扩展介绍 - Markdown转pdf

nanyue 2024-07-18 22:17:04 技术文章 7 ℃

前言


作为免费开源的代码编辑器,Visual Studio Code 本身并不支持直接输出 pdf 文件,但不要忘了强大的 Visual Studio Code 可以通过扩展来实现的。今天给大家推荐一款 Visual Studio Code 上的 Markdown转pdf扩展(Markdown PDF)。


一、扩展简介


(一)扩展基本信息:

(1)扩展名称:Markdown PDF

(2)扩展功能:将 Markdown 文件转换成 pdf、html、png 或 jpeg 格式文件。

(3)开发者: yzane

(4)最新版本: V1.4.4 (2020/03/19)

(5)GitHub项目地址:https://github.com/yzane/vscode-markdown-pdf

(6)Marketplace:https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdf


(二)扩展主要特性:

(1)支持语法高亮

(2)支持表情符号

(3)支持 markdown-it-checkbox

(4)支持 markdown-it-container

(5)支持 markdown-it-include

(6)支持 markdown-it-plantuml

(7)支持 mermaid

(8)支持导出四种文件格式:pdf、html、png、jpeg



二、扩展安装


Visual Studio Code 上安装 Markdown PDF 扩展非常简单,如下图示:

步骤说明:

(1)打开 Visual Studio Code 软件,鼠标点击左侧的扩展图标(见标号1处

(2)在右侧出来的扩展: 商店下的搜索栏中输入“pdf”(见标号2处);

(3)选择 Markdown PDF 扩展,点击右侧的安装按钮(见标号3处)进行扩展安装;

(4)本扩展安装过程会稍慢些,建议安装完毕重启 Visual Studio Code。

注:Markdown PDF 安装完成后,当首次使用 Visual Studio Code 打开 Markdown 文件时,会自动下载安装 Chromium ,此时在状态栏会显示 Installing Chromium 提示(如下图):


三、扩展设置


(一)设置配置选项markdown-pdf.executablePath

因 Chromium 文件较大(Windows上约280Mb、Linux上约282Mb,Mac上约170Mb),可能会出现下载缓慢或下载失败的情况,或者希望在每次升级 Markdown PDF 时避免重新下载安装 Chromium,则可以通过对配置选项 markdown-pdf.executablePath 进行设置来指定已安装的 Chrome 或 Chromium 的路径来解决。

设置步骤如下:

(1)鼠标依次点击菜单项【文件】-【首选项】-【设置】,进入“设置”面板;

(2)在搜索框(标号4处)中输入“markdown-pdf.executablePath”,在“用户或工作区”的下方会给出符合要求的 Markdown PDF 扩展配置项;

(3)然后在下方的输入框(标号5处)中输入已安装的 Chrome 路径。

如电脑上的谷歌浏览器 Chrome.exe 的路径为:C:\Program Files (x86)\Google\Chrome\Application\Chrome.exe,则应输入:C:\\Program Files (x86)\\Google\\Chrome\\Application\\Chrome.exe

或者直接在 settings.json 文件中添加:

 "markdown-pdf.executablePath": "C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe"

(二)其他扩展设置

可以根据需要,参照上面方法来对其他扩展选项进行设置。


四、扩展使用


(1)首先在 Visual Studio Code 上打开一个已经编辑好的 Markdown 文件

(2)执行转换操作(有两种操作方式)

操作方式一:通过命令面板方式进行Markdown转pdf操作

<F1><Ctrl+Shift+P> 快捷键调出命令面板,在命令面板中输入 export 后显示如下下拉框,

根据要转换的目标格式进行选择,如只需将 Markdown 文件转换为 pdf 文件,则选择第2项 Markdown PDF: Export (pdf) 回车,运行 Markdown PDF 的编译命令。

操作方式二:通过右键菜单方式进行Markdown转pdf操作

点击鼠标右键,在弹出菜单窗口(如下图)中,Markdown PDF: Export (pdf) 回车,运行 Markdown PDF 的编译命令。

此时会在窗口右下角显示如下动态提示:

(3)如果转换成功会在当前目录下生成相应的 pdf 文件,打开pdf如下图:

注1:目前 Markdown PDF 扩展功能还有待完善,如果 Markdown 文件中存在一些该扩展尚不支持的特性(如:不支持gif图片),则在转换时会提示转换失败。

注2:因 Markdown PDF 扩展对应的缺省 markdown-pdf.css 文件还比较简单,为了转换成的pdf文件能更为美观,还可以自行对 markdown-pdf.css 文件进行修改。


结束语


Visual Studio Code 安装上这款 Markdown 转 PDF 扩展后,开发人员就能将撰写的大部分 Markdown 格式的文档方便的转换成 pdf、html、png 或 jpeg 格式的文件了。希望介绍的这款扩展能对您有所帮助!

如果这篇文章对您有所帮助,喜欢的话就点个赞加关注支持一下哈:)

最近发表
标签列表