本文主要讲解的是用vuepress搭建一个技术文档,且这个技术文档是与github pages 相关联的。就是我们常见的下图的这种:
![](http://pgml4ovw7.bkt.clouddn.com/WX20181015-134600.png)
最终效果如下图:
![](http://pgml4ovw7.bkt.clouddn.com/WX20181015-135331.png)
如果与你想要做的一样,请仔细阅读下面的内容。
重要提示
本文不会重复介绍官方文档的内容,官网的API已经写得很详细并且写得很好了。所以,请先按照官网的讲解一步步实践,如果遇到其他的问题,这篇文章的内容也许能够帮到你。去官网
背景
一开始我并不是想直接搭建一个技术文档,我们团队是先开发了一套快应用UI组件库Quist-UI,为了方便开发者阅读,最后决定用vuepress搭建。所以,我用的安装方式和官网介绍的现有项目安装是一致的。