Nothing is true. Everything is permitted.
写在前面
先聊聊为什么想到了要用Vuepress来代替原来写在Confluence上的文档。
大意是有个需要其他部门接入的项目,这个项目有个用md写的接入文档,其他部门的人需要看着这个文档才知道怎么接以及哪些东西需要接。
但是有个问题是这个文档长的一匹,有多长呢?
而且这个md文件是放在confluence上的。
本身用confluence阅读md的体验就不好,这个文档能够让你的滚轮滚个足足十多秒,skr~。
你想要看的某个小章节就藏在这一大坨文字里。即使从最上面的导航锚点定位到了想要看的地方,但是你看着看着,滑着滑着就不知道自己在哪儿了。
然后找了半天,要么你运气好找到了。要么就只有回到最上面的导航,在一堆导航里再找一次。如果你运气究极不好,可能还要把上面的步骤重复几次,真的到了那个时候,你的心态可能就炸了。还接个毛的业务,心里只想找到写文档的人,然后一顿操作。
这就是为什么,我想换个方式来展示这个接口文档。
说到这个,又不得不吐槽。去网上找了很多vuepress的使用,总体下来两个字,复杂。再去看看vuepress的官方文档(虽然最后的解决方案都是在官方找到的),总结下来也是两个字,懵逼(因为我想找的那个地方藏得比较深)。
于是就有了写这一期硬核教程。