使用VSCode搭建Markdown写作环境

213次阅读
没有评论

共计 1130 个字符,预计需要花费 3 分钟才能阅读完成。

前言

在寻找 Markdown 编辑器的时 我尝试了Wordpress 的 WP Githuber MD 插件, Typora ,以及各种在线版Markdown编辑器. 鉴于我个人编写文章时的实际需求

  1. 可以通过Git版本控制软件管理
  2. 离线编辑流畅编写
  3. 可学习 Markdown 语法
  4. 可同时发布各种文档格式

最终我选择了使用 VSCode 来编写我的博客文章发布使用 Pandoc 结合我这篇文章 博主 Markdown 语法学习笔记 中所提到的一些参考网站搭建了我的 Markdown 写作环境. 或许程序员的最终归宿就是VSCode吧…🤣

VSCode

VSCode 官网 VSCode的安装使用这里不做赘述.

VS Code 本身对于 Markdown 来说只是简单地支持了它的编辑操作, 并没有对于编辑体验做过多的优化, 特别是对于中文编辑来说体验甚至不如记事本.以下主要介绍我在搭建 Markdown 编辑环境时所用到的插件以及配置思路.

Markdown All in One

Markdown All in One 插件首页 | Markdown All in One 文档介绍

这款插件提供了很多键盘快捷键, 可以让你一键式的插入表格, 有序列表自动添加数字等操作.如 Ctrl + Shift + F 可以一瞬间格式化你的表格. 安装后可以提升在VSCode里面编写 Markdown 的体验, 不会是像在编辑纯文本那样没有任何快捷键了, 平常也不用刻意去学习它的快捷键需要使用的时候再看.

markdownlint

markdownlint 插件首页 | Markdown All in One 文档介绍

这个拓展用来检查编写的文件是否符合标准. 这款插件默认的检查风格遵循最大兼容度原则, 实际使用的时候你需要根据你所使用 Markdown 文档发布工具进行配置, 哪些语法是兼容的哪些语法是不兼容的. 在最开始使用的时候我会先把所有提示全部关掉按照自己的习惯编写MD文件, 在使用导出软件的时候再看实际的导出效果, 查看不兼容的地方再到这个插件中打开提示, 下次编写的时候再注意.

Pandoc

Pandoc 官网

以下命令会生成一个由 markdown 文档所转换出来的 html 结构文档, 它并不是完整的 html 文件, 只包含你编写的 markdown代码的转义, 这样我们可以用 markdown 生成 html 结构然后再放到 WordPress 编辑器代码窗口里面插入 由 WordPress 的主题来渲染样式 markdown 只编写结构.

pandoc --wrap=none -f markdown src.md -t html -o dist.html

总结

本文提供一个markdown创作发布html文章的思路, 在 VSCode中编辑文档结结构, 使用 pandoc 生成所需最终展示的文档结构, 再放到 WordPress 中进行最终的样式渲染. markdown只提供结构.

正文完
 1
太阳
版权声明:本站原创文章,由 太阳 2022-10-20发表,共计1130字。
转载说明:除特殊说明外本站文章皆由CC-4.0协议发布,转载请注明出处。
评论(没有评论)