【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是无法生效的喔~

点击右键完成转换

nbsp-vscode

Highlights non-breakable spaces and other similar Unicode characters that might be hard to spot, also highlights trailing whitespace.

Markdown All in One

Allows for markdown keyboard shortcuts to bold text, underline, etc. Also formats tables and lists cleanly. 

Note: Some authors have reported issues with this extension which make editing impossible. If you get a keyboard error, uninstall this extension before you call for help. This extension also automatically numbers lists. Update the settings to use "1." for all numbered list items.

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容