【Doc as Code】推荐几款Visual Studio Code插件

推荐几款我日常在Doc like code中常用的Visual Studio Code Editor插件。

Markdown语法与样式检查

Markdownlint -- Markdown/CommonMark linting and style checking for Visual Studio Code
简介:
markdownlint is an extension for the Visual Studio Code editor that includes a library of rules to encourage standards and consistency for Markdown files.
推荐理由:作为writer,会在多种写作工具间切换(word, confluence, markdown),比较少用的markdown语法难免会遗忘。有了这个插件,熟悉markdown语法与样式后,但凡有语法或样式问题,它会在出错处加波浪线,点击提示,会显示violate的具体规则。

Markdownlint

Authorship呈现工具

简介:GitLen -- Visualize code authorship at a glance via Git blame annotations and CodeLens, seamlessly navigate and explore Git repositories, gain valuable insights via rich visualizations and powerful comparison commands, and more.
推荐理由:在日常协同写作中,一份大文档通常有多达十几位writer在维护。有时由于不同模块feature间有交叉,我们会修改同一章节,因而会想知道谁修改了我章节(Git Blame功能)。
这个插件直观地在VSC editor里可视化了这个功能。鼠标点击相应段落,就可以看到是谁最后修改了它,以及以往谁修改过它。我把这个插件推荐给了Localization的小伙伴。平时,他们会给writer反馈translator发现的问题,经常无法准确定位谁是author,把反馈错发了。:-)

安装与启用

Note: 启用后会影响VSC编辑器的响应速度,推荐不需要时Disable。

使用展示

Markdown文件格式转换工具

简介:Markdown PDF -- Converts Markdown files to pdf, html, png or jpeg files.
推荐理由:日常review过程中时常是需要把markdown文件转成Word格式,发给没有GitHub或是Bitbucket权限的小伙伴review。使用该插件,可以将markdown文件直接转成PDF。不过,我的需求是:转成Word文档,但这个直接转换功能是没有的。我的办法是:先转成HTML,然后全文复制粘贴内容到Word里,就OK啦!当然hyperlink是无法生效的喔~

点击右键完成转换


如果觉得我的推荐有用,请点赞、喜欢、并收藏喔!

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