文章简介
五一没事在家,对之前写过的所有的技术文档重新整理了一遍。七七八八的文章,都汇集到一个平台,GitHub
之前有通过语雀、个人博客和自建的文档系统等工具来整理自己的文章,这次也取消了,都使用GitHub存储。
这里也会分享自己用过的平台,以及其中的优点或者缺点。整理的文档目录大致如下:
Snipaste_2021-05-05_04-59-05
使用过的平台
语雀
语雀是一个专业的云端知识库,是蚂蚁集团旗下的一款文档类型的创新工具。语雀里面有团队功能、知识库功能,这两个功能差不多已经满足我的实际需要了。有PC端、网页端和微信小程序端,查看文档也是蛮方便的。最近在使用中发现一个不足的地方,将文档导出PDF来之后是没有书签功能的,个人在实际中也特别需要这个功能,于是便放弃使用语雀。
个人博客
个人博客系统属于个人自定义功能开发,能够完全自由发挥功能。但是需要个人做技术维护,单纯的为了一个博客,也觉得麻烦,后来也开始抛弃个人博客这种记录方式。
mindoc
MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂,所以改用 Golang 开发。可以方便用户部署和使用,同时增加Markdown和HTML两种编辑器。功能类似于看云,比较好的就是能整理一套完整的技术手册。
现在使用的平台
现在使用的技术平台或者工具,主要分为如下几种。部分软件属于收费版本,可以关注个人的公众号进行获取。
Snipaste_2021-05-05_05-12-38
Draw.io
Draw.io是一款绘图工具,可以绘制逻辑图、流程图、思维导图和UML图等,使用起来也非常的方便。主要用它有如下几个优势:
- 支持多端操作,有网页端、客户端、移动端、浏览器插件模式。
- 网页端可以实现文件多平台存储,例如GitHub、谷歌云盘等存储方式。
- 还可以基于开源代码,自定义部署一套该系统。
当然也存在不足的地方,例如:
- 客户端好像是没法登陆的,同时编辑的文件没法自动同步到其他平台存储,要想有这个功能,只能在网页端实现。
Snipaste_2021-05-05_05-16-02
ProcessOn
ProcessOn是一款网页端的逻辑图、流程图、思维导图和UML图等功能的工具。主要用它有如下几个优势:
- 有免费版本,通过邀请好友或者其他的方式可以增加免费文件数量。
- 基于网页端,不收设备的限制。只需要一个浏览器就可以随时随地地处理个人的文档。
- 模板广场,模板广场有丰富的模板可以供自己筛选或者学习,同时自己也可以将个人的一些文档分享出去。
- 支持流程图、思维导图、原型图、UML、网络拓扑图、组织结构图等,功能非常强大。
- 同时您可以把作品分享给团队成员或好友,无论何时何地大家都可以对作品进行编辑、阅读和评论。
至于为什么不用它,有几个感觉不是很好的地方。
- 思维导图中的备注只支持纯文本形式,并且导出到其他的工具上,例如xmind是不能正常打开,这种兼容性不强(这种问题不能说是ProcessOn的问题,只是针对个人使用觉得这点不好)。
- 虽然网页端不会受到设备的限制,但个人还是比较偏向于客户端,感觉客户端的体验性更好一些。如果没有网络,使用客户端基本上不会受到影响。
- 所以我只是单纯拿来做思维导图,至于流程图、逻辑图等等都是用Draw.io是实现。
Snipaste_2021-05-05_05-19-56
mdnice
mdnice是一款基于网页端的Markdown编辑器工具,现在也推出来客户端。从功能来说,总体还是不错的,更加专注于文档的写作方面。使用它有几个优势:
- 基于网页端,可以不受设备的限制。
- 超级丰富的主题,这也是我用该软件的主要原因之一。我们可以使用平台现有的主题,同时也可以自定义或者基于平台的主题来进行修改。个人在使用过程中,感觉平台的主题也足够使用了。
- 文件导出,支持导出Markdown、PDF的文件格式。
- 图像上传,这也是使用该软件的主要原因之二。当编写文档时,可以直接右键选择上传图片,图像自动上传并且将对应的URL以Markdown的语法格式插入到对应的文档中。图像存储的平台也算可以,支持mdnic自有的存储服务、阿里云存储、Gitee存储和GitHub存储,配置起来也是超级方便。
- 多平台发布,这也是使用该软件的主要原因之三。虽然Markdown的语法格式在全网的技术平台中,基本都支持了。但也有部分平台还不支持,例如微信公众号还不支持这种语法,每次写完之后都需要单独转换一次。该软件直接点击一个按钮就可以了,完全不需要做其他的处理,并且你可以根据自己的喜好来设置主题,渲染出来的主题格式微信公众号也是支持的。
当然也存在不足的地方,例如:
- 导出的PDF格式,内容没法生成目录书签。同时导出的文档格式比较单一。
Snipaste_2021-05-05_05-23-41
Mweb
Mweb是一款适用于Mac系统的收费类写作软件。功能非常丰富,也是个人强烈推荐的一款写作类工具。该工具的优势众多,下面就罗列几个个人在使用中比较常用的功能。
- 自动多平台同步,当你写完一篇文档想同步到其他的平台,或者这是一个麻烦却没技术含量的一件事情。该工具可以一键帮你同步到其他的平台,可以同步到语雀、少数派、为知笔记、WordPress等平台,同时也支持自定义同步脚本。
- 图像存储众多,可以自动同步到七牛云、又拍云、阿里云和腾讯云等平台上去,同时支持自定义文件上传。
- 文件导出,支持PDF、word、HTML、RTF等文件格式。导出文档应该是前面介绍的几个工具中,最好用的一个,支持导出PDF书签、TOC目录。这是一个最吸引我的地方。
- 其他的功能,例如文档编排、视图设置等在其他的平台基本都有,在该软件上都有体现,相对来说不是什么特别的优势,但功能都有也是非常不错的。
不过也有不足的地方,就是渲染的主题,不是特别好看,甚至可以说有点丑。个人在使用中,都是现在该工具上写好,然后用mdnice的主题功能渲染发布到公众号。
Snipaste_2021-05-05_05-30-26
总结
- 上面提到的几款工具都有各自的优点和缺点,并不能说明哪一款工具好,哪一款工具不好,只能说相对而言。也不存在诋毁哪一个工具,宣扬哪一款工具。
- 对于这几款工具也是在试用的过程中,后期在根据实际情况做一些更新和完善,大家觉得有帮助的可以关注或者给出你认为不错的写作工具。