身为一个重度 Markdown 用户,日常在 VSCode 中编写文档时,总会被一些细节问题反复折磨。例如,
- 为了格式美观,在中文和英文之间、中文和数字之间必须手动添加空格,不仅麻烦还特别影响效率
- 使用 code 语法也就是反引号,操作繁琐又得重复多次,非常消耗耐心;
- VSCode 自带的预览效果也不尽人意,样式简陋,很难提前看到满意的呈现效果。
这些问题虽小,但长期积累下来,着实让我在编写过程中苦不堪言。于是,为了给自己打造一个更顺畅的 Markdown 编写环境,我决定动手开发一款专属插件,现在就来给大家详细介绍介绍。
插件名称:Markdown Assistant
插件核心功能详解
自动添加空格
在编写文档时,我们不需要时刻记得在中英文、中文数字之间添加空格。只需要在文档编写完成后,执行 Markdown Assistant: insert space 命令,就可以自动在中文英文、中文数字之间添加空格,可以大大提高我们的效率。这部分实现参考了 Pangu-Markdown-VSCode 插件。
快捷代码化
在写技术文档时,经常会使用到 code 这一语法,对代码语句或单词进行代码化。为了简化这一操作,在插件中我实现了自动添加 code 的功能。当我们选中一个单词或文本时,执行 Markdown Assistant: add single backtick,选中的单词就会代码化。
对于同一个单词或语句重复多次的情况,可以执行 Markdown Assistant: add batch backtick 语句,该命令会匹配当前文档中相同的内容,批量的添加反引号(不包括标题、代码块和注释)。
待办事项复选框支持
在 Markdown 写作中,待办事项是很常用的元素。插件支持直接创建待办事项复选框,你只需按照常规 Markdown 语法输入 [ ] 事项内容 ,就能生成一个可勾选的待办事项。勾选后,事项前的方框会自动打勾,方便你管理任务进度,让文档条理更加清晰。
code 词典功能
插件内置了词典功能,你可以将常用的单词添加到词典中。当调用 Markdown Assistant: format 命令时,
- 词典中的单词会自动被加上反引号,避免了手动添加的麻烦。
- 会自动执行插入空格的命令。
比如,你习惯对 vue3 这个词添加反引号,使其 code 化,可以调用 Markdown Assiatant: add word to dictionary 将其添加到词典。这样,以后在编写其他文档时,可以直接执行 Markdown Assistant: format 命令,那么该文档中的 vue3 将会变为 vue3
翻译功能
在做开源项目时,如果你想为项目添加一份英文README文档,那么这个功能可能会帮助到你。该功能配置如下:
借助先进的大模型翻译能力,可以将 Markdown 文章翻译为英文。目前支持硅基流动 Qwen/Qwen2.5-Coder-7B-Instruct 模型(该模型目前免费)和本地 ollama 模型,硅基流动 api key 需要去官网申请。API 服务地址仅在选择服务提供商为 ollama 时生效。
只需要执行Markdown Assistant: translate to English, 就会开始翻译文档内容,并将翻译好的内容写入新的markdown文件。
优化预览效果
在优化 markdown 预览效果方面,支持了以下内容:
- 添加了info、tip、danger、wanring、details五种container。
- 支持使用表情 :100:
建议可以直接使用
Markdown Assiatant: format命令,该命令内部集成了自动插入空格的功能
如果该插件对你有小小的帮助,希望大家在GitHub上可以 star 下🙏
- 仓库地址: github.com/lyx-jay/eas…
- vscode插件:
在使用的过程中如果遇到问题,欢迎提交 issue
如果大家有更好的想法,欢迎一起交流呀!