查看原文
其他

这款即将开源的编辑器可能是最适合程序员的文档工具!

码农翻身 2022-10-10

作为程序员,我经常需要写技术文档,之前也用过很多文档工具,比如有道云笔记,石墨,腾讯文档等。


我感觉他们大同小异,无外乎是文档编写、分享、协作这些功能,就像Word的简化版和在线版。


朋友曾经给我多次安利过语雀,说这个工具不一样,让我尝试体验,最近又听说语雀编辑器要开源,我来了兴致,决定尝试一下。


没想到一试就惊喜地发现:这个语雀简直就是为程序员量身定制的一个文档工具啊!



01集成度极高的文档卡片


之前在写需求文档、架构文档、设计文档的时候,必然要用到代码、流程图、UML图。


那就需要在多个工具之间切换,比如先用Visio、ProcessOn等软件画架构图、流程图,UML图,然后截图复制到文档中,说实话还是挺麻烦的。


到了语雀这里,我发现了一个叫“文档卡片”的东西,可以把代码、流程图、UML图都给集成到了文档中。


比如插入代码:



画流程图:



画UML:


所有的内容现在都在同一个文档中编辑和展示,真是非常方便。


这让我想起了微软的OLE(对象的链接和嵌入),比如Word中有个图表,你一双击,它自动打开了Excel来进行编辑。但是OLE庞大又缓慢,我每次使用起来都得小心翼翼,生怕出了什么错误。


相比来说,语雀的文档卡片,也是在文档中嵌入非文字的内容,但是集成度更高,用起来就舒服多了。


文档卡片内容丰富多彩,除了上面说的,还支持直接插入B站视频,网易音乐、高德地图。



甚至还有TODO,打卡,日历、公式、投票......,想得非常周全。



02丝滑般的全键盘输入体验


使用语雀的时间长了,慢慢就琢磨出它隐藏的一个好处:丝滑般的全键盘输入


程序高手编程时大概都是这个样子:双眼紧盯屏幕,双手不离键盘,上下翻飞,代码像水一样流淌出来。


之所以能达到这个效果,就是熟记了各种快捷键,有很多软件如vi在设计上就是不用鼠标,所有的命令都是用键盘完成的。


语雀也有类似的特点,比如我在用文档卡片的时候,不用把鼠标移到工具栏上去插入什么卡片,只需要在编辑文档时输入 / 这个字符,卡片列表自然就弹出来了。


然后我只要输入拼音或者英文,自然就能找到自己想插入的卡片:



再加上各种各样的快捷键盘,基本上可以像编程那样,手不离键盘了。



03文档界的GitHub


在语雀闲逛期间,我又发现了一个好东西:每个人在语雀都有一个主页:



看看这些主页,它有关注者,有知识库,有动态,你能想到什么? 


对,这不就是GitHub吗?


只不过,GitHub上代码存储在代码仓库中, 语雀上的文档保存在知识库中。


看来语雀的知识库也引入了社交化的概念,我创建的知识库可以邀请别人加入,让大家一块儿来编辑,进行知识共创。


我关注的知识库文章如果有更新,我就可以收到更新通知,就像GitHub的代码通知一样。


这么发展下去,语雀有望成为文档界的GitHub啊!



04满足程序员不断折腾的“野心”


程序员都是喜欢折腾的,比如说我有一个自己的博客,我就会想,我在语雀发的文档,能不能自动同步到我的博客去啊?


我看了一下语雀的开发者文档,它有很多RESTful风格的API来对知识库、文档等进行增删改查。


语雀支持一个叫做Webhook的接口,当知识库下的文档被发布或更新的时候,可以调用一个外部的URL。


这个URL背后对应的是我们自己写的代码,可以做很多事情,比如最简单的调用那些RESTful风格API,获取文档,发到自己的博客上。


当然这是最原始的办法,现在已经有不少博客的插件,如Typecho,就有一个插件YuqueToTypecho直接支持从语雀同步文档,这里不再展开,感兴趣的可以上网搜下。


实际上,利用语雀的开发API,程序员自己就可以写一个语雀的客户端应用了,只有你想不到,没有你做不到。



05总结


经过一段时间的尝试,语雀给我留下了非常深刻的印象,这是一个完全站在程序员角度来思考的一个产品。


我搜了一下语雀的背景,它诞生于支付宝体验技术部,那里有一群工程师和设计师,他们发现身边的每个人、每个团队都有很多知识,但一直以来缺少一个好用的工具,让这些知识被方便地记录、分享和交流,所以才有了语雀。


我相信在研发过程中,他们绝对是“吃了自己的狗粮”,要不然,绝对不会有这么多贴心的,解决程序员痛点的功能。


最后,也给大家安利一下语雀这个工具,我的账号是onlyliuxin,我们互相关注一下吧。 

您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存