Markdown Preview Enhanced 使用教程
项目地址:https://gitcode.com/gh_mirrors/vs/vscode-markdown-preview-enhanced
1、项目介绍
Markdown Preview Enhanced 是一款为 Visual Studio Code 开发的 Markdown 预览增强插件。它提供了许多实用的功能,如自动滚动同步、数学公式渲染、Mermaid 图表、PlantUML、Pandoc 集成、PDF 导出、代码块执行、演示文稿编写等。该插件的灵感来源于 Markdown Preview Plus 和 RStudio Markdown。
2、项目快速启动
安装
- 打开 Visual Studio Code。
- 进入扩展市场,搜索
Markdown Preview Enhanced
。 - 点击安装。
使用
- 打开一个 Markdown 文件。
- 使用快捷键
Ctrl+Shift+V
打开预览。 - 使用快捷键
Ctrl+K V
在侧边打开预览。
{
"markdown-preview-enhanced.enableScriptExecution": true
}
3、应用案例和最佳实践
案例1:学术论文编写
使用 Markdown Preview Enhanced 可以轻松编写学术论文,支持 LaTeX 数学公式和 Pandoc 导出为 PDF。
案例2:技术文档编写
在编写技术文档时,可以使用 Mermaid 图表和 PlantUML 来绘制流程图和时序图,使文档更加直观。
最佳实践
- 自动同步:使用自动滚动同步功能,确保编辑和预览窗口内容同步。
- 代码块执行:在 Markdown 中嵌入代码块,并使用
shift-enter
快捷键执行代码。
4、典型生态项目
Pandoc
Pandoc 是一个强大的文档转换工具,支持多种格式之间的转换。Markdown Preview Enhanced 集成了 Pandoc,可以直接导出为 PDF、HTML 等格式。
Mermaid
Mermaid 是一个用于绘制图表的 JavaScript 库,支持流程图、时序图、甘特图等。Markdown Preview Enhanced 内置了 Mermaid 支持,可以直接在 Markdown 中绘制图表。
PlantUML
PlantUML 是一个用于绘制 UML 图的工具,支持类图、时序图、用例图等。Markdown Preview Enhanced 支持 PlantUML,可以在 Markdown 中直接绘制 UML 图。
通过以上教程,您可以快速上手并充分利用 Markdown Preview Enhanced 的功能。