目前为止最好的Markdown编辑器,我选择Visual Studio Code

主要需求

关于Markdown编辑器的事情,其实已经更换过好多了,因为完全找不到好用的,目前的诉求如下:

a. 支持PlantUML语法。——目前这个诉求已经挤到第一位了,因为在工作中画图的场景实在是太多了,当前主要工作是做架构设计,大量的文档要写。
b. 支持自动生成标题的序号,默认的Markdown语法的标题是不含序号的。
c. 支持自动生成目录的语法
d. 支持嵌入代码,代码支持各种语言的语法高亮
e. 支持使用<font>,<br>等HTML标签
f. 支持Latex语法。

语法参考

针对Markdown编写过程中常用的各种语法,因为年纪大了也会经常忘记,常常需要查阅资料,主要资料如下:

VSC配置

最终我使用了Visual Studio Code,点击这里下载。安装后,还需要在VSC的Extension中安装一些插件来丰富这些功能,目前安装的包括:

  1. Markdown All In One——主要的Markdown增强插件,该插件已经实现了上述#a,#c,#d,#e,#f功能。
  2. Markdown Preview Enhanced——用于在VSC中预览Markdown效果,默认的预览效果比较差,而且也不支持目录。而且这个插件也支持导出为PDF

PS: 前两个插件的作者都是中国人,感叹最近真是国力强大啊,各行各业都充斥着人才。。。

针对插件#1,主要增强的地方有:

  1. 支持[TOC]自动生成目录(略)
  2. 支持Latex语法(略)
  3. 支持嵌入代码,代码支持各种语言的语法高亮(略)
  4. 支持使用<font>,<br>等HTML标签(略)
  5. 支持PlantUML语法,使用效果为:
image.png

针对插件#2,点击这个按钮就可以启用VSC内预览功能。

image.png

这个插件可以支持内置多种高级功能,现在常用的主要就是plantUML了,毕竟其他几个画图的太丑。。。

介绍原文:

Introduction

Markdown Preview Enhanced is an extension that provides you with many useful functionalities such as automatic scroll sync, math typesetting, mermaid, PlantUML, pandoc, PDF export, code chunk, presentation writer, etc. A lot of its ideas are inspired by Markdown Preview Plus and RStudio Markdown.

https://shd101wyy.github.io/markdown-preview-enhanced/#/diagrams?id=plantuml

这里写使用PlantUML需要安装 Graphviz

You can install Graphviz (not required) to generate all diagram types.

针对插件#3,在文档中点击右键,选择Markdown Sections: Insert/Update就可以自动给每个菜单增加序号了。

image.png

导出为PDF

先选择使用Markdown Preview Enhanced插件预览,点击下面按钮:

image.png

预览后点击右键选择输出为PDF,这里可以选择多个编译器输出PDF,包括Prince、Chrome、eBook、Pandoc,最后看哪个输出效果好就行了。

image.png

--updated 2021/1/22

近期出现了画甘特图和饼图需求,plantuml不支持,可以用mermaid替换,也是脚本画图工具。语法参考:About mermaid (mermaid-js.github.io)

如果实在是图过于复杂,也可以先用draw.io画好生成矢量图svg,再嵌入到markdown中,svg可以直接编辑。地址:diagrams.net

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345