大家好,我是小麦,一名服务端开发工程师,今天给大家分享的内容是一款超级好用的文档用具。
不知道大家在日常的学习或者办公中,有这样的需求。
1、想搭建一个博客系统,用来记录自己在日常学习中的笔记。
2、想搭建一个wiki网站,用来分享自己的产品介绍文档、开发接口等内容。
在这样的需求驱动下,你可能会在网上搜索各种开源工具。我个人也是这样,在早期想搭建一个博客系统,用来记录自己的学习笔记,但又不想自己去重新开发一套这样的系统。虽然市面上也有很多符合需求的前后端开源项目,但自己又不想单独在去弄一套环境,感觉没必要也很麻烦,是不是感觉很挑剔。
在这个过程中,我也体验过很多的前后端系统,最终都在使用一段时间后,全部放弃了。例如大名鼎鼎的WordPress,以及后期的mrdoc、mindoc,虽然这几款工具在安装或者使用上都非常的便捷。但个人还想要更简单一些,减少去部署后端服务的过程,直接能够像纯HTML一样部署即可。关于文档系统,我之前也分享过几篇,感兴趣的同学可以了解一下。
1、2分钟带你 搭建一个开源的轻量级笔记服务应用
2、开源MrDoc,一个适合个人和小型团队的文档、知识、笔记在线管理系统
3、WordPress最受欢迎的主题模板
经过反复的折腾了N次,最终发现一款宝藏级别的文档工具,也是非常多的开源产品、博客系统在使用的一个开源文档工具。这就是大名鼎鼎的Vue.js作者开发的VitePress。
VitePress 是一个静态站点生成器 (SSG),专为构建快速、以内容为中心的站点而设计。简而言之,VitePress 获取用 Markdown 编写的内容,对其应用主题,并生成可以轻松部署到任何地方的静态 HTML 页面。
我这里做一个简单的总结吧,可能不全,主要从我使用下来的整体体验。
1、VitePress是完全支持markdown语法,并且你编写的markdown内容能够直接复制到其他的技术平台。这也是markdown非常受欢迎的原因之一。
2、VitePress对SEO的友好支持,作为Vue技术栈,很多人可能担心不能做SEO,毕竟自己搭建一个网站还是希望更多的看见。VitePress完全支持全局、单页面配置SEO内容,同时也支持sitemap的生成。所以你完全不用担心SEO问题。
3、国际化支持,如果你的网站涉及到多种语言,VitePress支持你按照规定的方式去自动适配多语言。
4、多主题的支持,VitePress默认提供主题,也支持对默认主题的扩展;同时也支持自定义主题,你完全可以根据自己的需要来定制化一套适合你的主题。
5、连接CMS,如果你的网站部分内容涉及到鉴权,或者需要通过其他系统获取到内容,VitePress是完全支持你通过调用其他系统的接口,来生成页面内容。
7、强大的搜索能力,好的网站一定会主动用户体验性,例如搜索功能就是其中之一,用户通过搜索能够快捷的搜索自己所需要的内容。VitePress支持本地化搜索,同时也支持algolia搜索,仅仅配置几行代码即可。
从使用下来,从我个人的体验而言。VitePress最大的优点在于不依赖任何环境就能运行,你可以将它当做前端纯HTML、CSS和JavaScript。
在部署方面也非常的简单,你只需要在你的服务器端部署一个NGINX服务即可。在部署时,推荐使用静态化部署,几个命令即可完成。
1、本地编译打包,会生成一个dist目录的文件,直接部署该文件目录即可。
2、NGINX部署,直接使用下面短短几行配置即可。
3、最后就可以看到效果啦,下图就是我部署后的效果图,感兴趣的同学也可以访问wiki.tutudati.com进行预览。