先说下选择Markdown编辑器的原因,我们进行平台开发,需要很多的操作手册和API文档,要在网站中展示出来就需要是HTML格式的文件,但是由于内容很多,不可能全部由技术人员进行文档的编写,如果是只有文档操作经验的人来做就会出现很麻烦的情况。
最初,我们先用试着用word来写,再转换成HTML文件保存,但是这样存在几个问题:1、转换出来的文件标签和样式十分的杂乱和冗余,有太多无用的标签,后期要修改样式也十分不容易;2、图片无法保存,在word文档中插入的图片路径是固定的物理路径,或是与文档一起存储的,当文档转换成HTML文件并放在网站服务器上使用时,图片的路径就发生了变化,如果再去调整图片就十分麻烦;3、关于图片还有种解决的办法,word可以保存为htm格式,这种格式是将图片和文字一同保存在一个文件的方法,但是最后的结果是只有IE可以识别这种格式,在Chrome里都是乱码,所以最后同样作罢。
在一些编写API文档的专门网站中,我偶然看到markdown编辑器,向经理提了一下,他说之前就考虑这个,所以就由我来开发(好大一个坑)。
网上找到的开源markdown编辑器中,我第一个看中的是Editor.md,发现用的人很多,相关的帖子也不少,所以最开始是用这个开发的,最初在单独的网页上实现也很快,但是拿到框架里就出现了一些兼容性问题很难解决,并且需要引用很多文件,与我们的需求相比,它太臃肿了,功能不够简洁,而且,最关键的问题是,我找到GitHub上发现,这个编辑器已经有两三年没有更新了,很多问题都没有好的解决方法,所以现在的用户也不多,网上有的都是遗存的帖子,之前没有注意到发帖时间。。。
然后就继续寻找,后面的详细过程记不太清楚了,总之是发现现在需要用markdown编辑器开发者几乎都是自己开发,而我又不具备这种能力,最终是找到了markdown plus这个比较轻量级的编辑器,开发者最初也是遇到和我一样的问题,从开始用Editor.md到最后自己开发,所以他在开发过程中尽力使代码简洁,并且最近几个月还在更新,在这个过程中还推出了Windows版和Mac版,十分推荐。另外CSDN上的markdown编辑器中标注使用的StackEdit也非常好用,有独立的网页版本,同时代码也是开源的,不过我还不太会用,下一节就是具体记录相关的踩坑过程,使用Git、yarn之类的工具的情况。
在查找这些相关资料和编辑器的过程中,我能学到很多细微的知识,虽然花了很多时间,走了很多弯路,但也开始慢慢地掌握程序员学习进步的基本,希望以后能更有效率地开发。