前言
对于程序猿来说,markdown是我们非常熟悉的文档编写方式,在开发项目时,我们可以通过它来写出结构清晰案例完整的项目管理或者接口文档等。
Markdown 作为程序员写作的心头爱,有很多优点:
- 通过语法实现排版,不需要点选手动设置样式
- 快速实现复杂内容,如:代码块、超链接、公式等
- 让创作者有更多时间专注于内容
但,同样的也有些缺点:
- 繁琐的语法又不能全都记住,时不时还得翻翻文档
在HelloGitHub的推荐下,我发现了这一款有着高颜值以及丰富插件的Milkdown,集合 Markdown 编辑器、组件、插件于一身的开源项目。
概览
Milkdown 是一个轻量但强大的 WYSIWYG(所见即所得)的 markdown 编辑器。它有两部分组成:
- 一个小巧的核心,提供了插件加载器和一些内置插件。
- 大量的插件,包括语法、命令和组件。
通过这种模式,你可以根据喜好开启或关闭语法和功能,例如表格,数学公式或斜线指令。你甚至可以创造自己的插件来实现你的想法。
特性
上手
官方给出了下面2种方式上手,可以直接在网页上体验:
- 在线尝试:https://milkdown.dev/#/zh-hans/online-demo
- VS Code插件:https://marketplace.visualstudio.com/items?itemName=mirone.milkdown
在VS Code中使用Milkdown
1.安装Milkdown插件
首先,先在VS Code中安装Milkdown插件。
2.新建md文件
安装好Milkdown插件后,新建/打开一个md文件(后缀为.md
’的文件)
3.使用Milkdown插件
在已经打开的md文件里,通过快捷键Ctrl+Shift+p
调出用于执行命令的输入框,并输入Milkdown
选择图中所示,便可以使用Milkdown插件编辑md文件了。
结尾
-
在编写本文时,使用Milkdown VSCode插件打开已经写好的md文件时,会显示一片空白,具体原因不清楚,已经在插件库反馈给开发人员了。
-
具体使用技巧可以阅读官方文档。
-
参考链接: