之前介绍过几款搭建开源项目文档的工具,有Docsify、VuePress和Hexo。这些工具有个共同点,需要一些开发部署的工作,部署基本依赖Github Pages或者自建服务器。那么有没有那种开箱即用的工具呢,最近发现很多开源项目都用
语雀
来搭建文档网站,体验了一把,非常不错,推荐给大家!
语雀
是新一代的云端知识库,可以写出像书一样的项目文档,拥有专业好用的编辑器(支持Markdown转换),方便的团队协同功能。
主要使用场景如下:
我们先来看下成品效果,开箱即用,界面还是挺不错的!
在使用语雀之前,我们需要对其中的概念有所了解。下面介绍下这些核心概念,然后再展示下对应的界面。
接下来我们使用语雀来搭建一个开源项目文档,以我的开源电商项目mall为例。
空间
,用于存放团队和知识库;知识库
,由于我们的知识库主要用于存放文档,所以选择文档知识库
,然后输入名称、简介即可;文档
了,直接复制之前使用Markdown写的文档即可,然后点击右上角的立即转换
;编排目录
功能;其实到这里,我们已经学会了如何制作一个开源项目文档网站了,但是此时文档网站的首页只是一个目录,这样未免有些单调,如果我们想要首页内容更丰富些,我就需要创建
团队
,然后自定义团队的首页即可;
官方文档
模板;自定义首页
功能,使用图形化界面来完成一个首页,下面是我已经完成好的首页效果;团队
中去;如果你想搭建一个私有的文档网站的话,上面的操作基本能满足需求了,但如果你想搭建一个公开的文档网站的话,还需要如下操作。
知识小组
,可以选择官方文档
模板;互联网可见
,这才是真正公开的团队;知识库设置->高级设置
中,选择导出为.lakebook
格式;互联网可见
,并导入.lakebook
文件;通过使用语雀搭建开源项目文档的一波实践,我们可以发现这种方式确实比使用Docsify来自建网站简单太多了,既不需要编码,也不需要买服务器。怪不得很多开源项目都用它来搭建文档网站,当然语雀的功能还不只这些,用来做在线云笔记也挺好用的,如果大家感兴趣的话,可以自己探索下!
https://www.yuque.com/
到目前为止,我们已经介绍了四种搭建开源项目文档的方式,有Docsify 、VuePress 、Hexo 和本文的语雀
,你觉得那种好,来投票看看!