VSCode Markdown转PDF终极指南：高效文档转换实战手册

【免费下载链接】vscode-markdown-pdf Markdown converter for Visual Studio Code 项目地址: https://gitcode.com/gh_mirrors/vs/vscode-markdown-pdf

VSCode Markdown转PDF是一款强大的Visual Studio Code扩展，能够将Markdown文件快速转换为PDF、HTML、PNG或JPEG格式。无论是技术文档、学习笔记还是项目报告，这款工具都能帮助你轻松实现文档格式的转换与分享，提升工作效率。

为什么选择VSCode Markdown转PDF？

在日常工作和学习中，我们经常需要将Markdown格式的文档转换为更通用的PDF等格式。VSCode Markdown转PDF扩展凭借其丰富的功能和便捷的操作，成为了众多开发者和写作者的首选工具。它支持语法高亮、emoji表情、PlantUML图表、mermaid流程图等多种特性，让你的文档更加生动和专业。

核心功能亮点 ✨

• 多格式输出：支持将Markdown文件转换为PDF、HTML、PNG、JPEG等多种格式，满足不同场景的需求。
• 丰富的扩展支持：集成了多种Markdown扩展，如markdown-it-checkbox、markdown-it-container、markdown-it-include等，增强了Markdown的编辑能力。
• 图表渲染：支持PlantUML和mermaid图表的渲染，让技术文档中的流程图、时序图等更加直观。
• 自定义样式：可以通过CSS样式表自定义文档的外观，打造个性化的文档格式。

快速安装指南 🚀

安装VSCode Markdown转PDF扩展非常简单，按照以下步骤即可完成：

1. 打开Visual Studio Code。
2. 进入扩展面板（快捷键Ctrl+Shift+X或Cmd+Shift+X）。
3. 在搜索框中输入“Markdown PDF”。
4. 找到由yzane开发的Markdown PDF扩展，点击“安装”按钮。

安装完成后，首次打开Markdown文件时，扩展会自动开始下载Chromium（约170Mb-280Mb，具体大小因操作系统而异）。下载过程中，状态栏会显示“Installing Chromium”的提示信息。

如果你使用代理网络，可以在settings.json中设置http.proxy选项，然后重启VSCode。如果你希望避免每次升级都下载Chromium，可以通过markdown-pdf.executablePath选项指定已安装的Chrome或Chromium路径。

三种高效使用方法详解

方法一：通过命令面板导出

这是最常用的方法之一，操作步骤如下：

1. 打开需要转换的Markdown文件。
2. 按下F1或Ctrl+Shift+P（Mac用户为Cmd+Shift+P）打开命令面板。
3. 输入“export”，然后选择你需要的导出格式，如“markdown-pdf: Export (pdf)”、“markdown-pdf: Export (html)”等。

方法二：通过右键菜单导出

如果你更喜欢通过鼠标操作，可以使用右键菜单：

1. 打开Markdown文件。
2. 右键点击编辑区域，在弹出的菜单中选择相应的导出选项。

方法三：保存时自动转换

为了进一步提高效率，你可以设置在保存Markdown文件时自动转换：

1. 打开VSCode的设置（Ctrl+,或Cmd+,）。
2. 在settings.json中添加以下配置：

   "markdown-pdf.convertOnSave": true
   

3. 重启VSCode使设置生效。
4. 之后，每当你保存Markdown文件时，扩展会自动将其转换为指定格式。

你还可以通过markdown-pdf.convertOnSaveExclude选项排除不需要自动转换的文件，例如：

"markdown-pdf.convertOnSaveExclude": [
  "^work",
  "work.md$"
]

个性化配置详解 ⚙️

VSCode Markdown转PDF提供了丰富的配置选项，让你可以根据自己的需求定制转换效果。你可以通过File > Preferences > User Settings或Workspace Settings来修改这些配置。

常用配置选项

输出格式设置

"markdown-pdf.type": ["pdf", "html", "png", "jpeg"]

通过该选项可以指定输出的文件格式，支持同时选择多种格式。

输出目录设置

"markdown-pdf.outputDirectory": "output"

设置转换后文件的保存目录。路径可以是绝对路径，也可以是相对于Markdown文件或工作区的相对路径。如果设置为相对路径且目录不存在，扩展会自动创建该目录。

样式自定义

"markdown-pdf.styles": ["styles/markdown-pdf.css"]

通过指定CSS文件来自定义文档的样式。项目中提供了styles/markdown-pdf.css、styles/markdown.css和styles/tomorrow.css等样式文件供你选择和修改。

PDF页面设置

"markdown-pdf.format": "A4",
"markdown-pdf.orientation": "portrait",
"markdown-pdf.margin.top": "1cm",
"markdown-pdf.margin.bottom": "1cm",
"markdown-pdf.margin.left": "1cm",
"markdown-pdf.margin.right": "1cm"

这些选项可以设置PDF的页面大小、方向和边距。

页眉页脚设置

"markdown-pdf.displayHeaderFooter": true,
"markdown-pdf.headerTemplate": "<div style=\"font-size: 9px; margin-left: 1cm;\"> <span class='title'></span></div> <div style=\"font-size: 9px; margin-left: auto; margin-right: 1cm; \">%%ISO-DATE%%</div>",
"markdown-pdf.footerTemplate": "<div style=\"font-size: 9px; margin: 0 auto;\"> <span class='pageNumber'></span> / <span class='totalPages'></span></div>"

通过这些选项可以自定义页眉和页脚的内容和样式，支持显示标题、日期、页码等信息。

高级功能探索

图表渲染

VSCode Markdown转PDF支持PlantUML和mermaid图表的渲染，让你的文档能够展示复杂的流程图和架构图。

例如，使用mermaid语法可以创建状态图：

代码块语法高亮

扩展内置了语法高亮功能，支持多种编程语言的代码块高亮显示，让你的技术文档更加易读。你可以通过markdown-pdf.highlightStyle选项选择不同的高亮主题，如github.css、monokai.css等。

分页控制

在Markdown中插入以下代码可以实现分页：

<div class="page"/>

实际应用示例

以下是一个转换后的PDF文档示例，展示了VSCode Markdown转PDF的强大功能：

常见问题解答

如何修改emoji的大小？

你可以在自定义CSS中添加以下样式：

.emoji {
  height: 2em;
}

如何自动猜测文件编码？

启用VSCode的files.autoGuessEncoding选项：

"files.autoGuessEncoding": true

如何设置输出目录为Markdown文件所在目录的子目录？

"markdown-pdf.outputDirectory": "output",
"markdown-pdf.outputDirectoryRelativePathFile": true

总结

VSCode Markdown转PDF是一款功能强大、使用便捷的文档转换工具，它能够帮助你将Markdown文件快速转换为多种格式，满足不同场景的需求。通过本文的介绍，你已经了解了它的安装方法、使用技巧和个性化配置选项。赶快尝试使用这款工具，提升你的文档处理效率吧！

如果你在使用过程中遇到任何问题，可以查阅项目的CHANGELOG.md了解版本更新信息，或参考项目的许可证LICENSE.txt。

【免费下载链接】vscode-markdown-pdf Markdown converter for Visual Studio Code 项目地址: https://gitcode.com/gh_mirrors/vs/vscode-markdown-pdf