前言
最近一直想弄一个文档网站,主要是文档网站看起来高端大气上档次,还有一个特点就是,看着正规。对正规。
还有一个就是文档网站内部的规划是属于一种树形,怎么说呢?意思就是说内部的数据框架是属于比较清晰,类似于一棵大树,有主干,有枝叶这种框架,这种框架对于目录有着清晰分配,对于各种类型的内容有着比较好的分离以及专注。换句大白话来说:这才像正版的嘛🤭。
为此我在网上专门找了一些搭建这类文档网站的开源源码。并且自己亲手测试了一下,下面我写一下这几天上手的体验哈。
- Vitepress
- Vuepress
- Docsify
Docsify
Docsify
个人感觉这个相对来说搭建起来比较简单,上手不算太难,基本上用不了多长时间就可以捣鼓出一个漂亮的文档网站,
但是这个给我的感觉就是有点过于简单,尤其是url,每个网址后面和目录中间都有个#
,对于这个我感觉相当的别扭。
docs/about.md => http://domain.com/#/about
docs/note/README.md => http://domain.com/#/note/
docs/note/note1.md => http://domain.com/#/note/note1
docs/note/note2.md => http://domain.com/#/note/note2
Vuepress
Vuepress
这个几把玩意我就没捣鼓成功过,看网上好多人用这个搭建起来的文档+博客,只能是羡慕妒忌的份儿了,我也纳闷的是我每次按照官网上的办法去搭建,就是搭建不成功,我也是醉了,每次不是这样的BUG就是那样的BUG,反正我是弄不成这个几把玩意儿。
我估计是我技术不到家,反正我是死活弄不成这个几把玩意儿。看别人用这个搭建的正规网站,只能是羡慕啦。😔
官网:https://vuepress.vuejs.org/zh/
Vitepress
Vitepress
话说这个跟上面那个Vuepress是一个孪生兄弟,这个我弄成了,现在在本地正在测试,与其说成测试,不如说正在学习怎么使用Vitepress。
这个在本地搭建的时候,上手没有Docsify
那般简单,但是这个没有了那个#
,这个看起来蛮舒服的。
这个也比Vuepress
好搭建,最起码没有那么多的BUG出现,😂。
现在在本地搭建的默认主题,首页那叫一个漂亮。目录也可以分的赏心悦目,对赏心悦目,怎么看怎么舒服。😄
最后
从我上手搭建的这三个开源项目,个人感觉最简单的非Docsify
莫属,这个我个人感觉是最简单的,也是最容易上手的。
也不知道Vuepress
是咋回事,反正我是没搭建起来,全是bug,也有可能是我技术不到家,也有可能是官网的文档说明好几年没更新了,反正我是没搭建起来,cao···
但是Vitepress
跟着他们的帮助文档搭建,会正常的搭建起来。而且他们官网的帮助文档最近更新日期是今年的。反正现在先捣鼓Vitepress
了。
以上三个开源项目都是支持一边编写一边热刷新,意思就是一边编写一边可以查看编写后在网页上呈现出最终的效果。