之前介绍过几个构建开源项目文档的工具,包括Docsify、VuePress和Hexo。这些工具有一个共同点,就是需要一定的开发和部署工作,而部署基本依赖于GithubPages或者自建服务器。那么有没有开箱即用的工具呢?最近发现很多开源项目都使用语雀搭建文档网站。我体验过,非常好。我把它推荐给了每一个人!SpringBoot实战电商项目商城(50k+star)地址:https://github.com/macrozheng/mall好用的编辑器(支持Markdown转换),便捷的团队协作功能。主要使用场景如下:个人笔记:语雀知识库有公开和私有两种功能,私有知识库可以作为在线云笔记,方便我们记录点点滴滴,积累知识。专栏博客:如果不想自己搭建博客站点,可以直接生成。项目文档:你见过可以多人协作的项目文档吗?官方文档:可作为产品说明和帮助手册。效果展示先来看看成品效果,开箱即用,界面相当不错!核心概念在使用语雀之前,我们需要了解这些概念。下面介绍这些核心概念,然后展示相应的界面。首先我们来看一下各个核心概念的关系图,有助于理解这些概念:空间:空间类似于公司或组织的概念,我们可以在其中管理团队、知识库、知识等.团队:空间下的团队可以链接到你实际的组织结构,比如部门团队、项目团队等知识库:知识库是知识内容的载体,就像一本书,你可以重新组织和分类知识库中的知识内容。知识:知识库中的内容,可以是文档。搭建接下来我们使用语雀搭建一个开源项目文档,以我的开源电子商务项目商城为例。快速搭建首先,我们点击左上角创建一个空间,用来存放团队和知识库;然后选择创建知识库,由于我们的知识库主要是用来存放文档的,所以选择文档知识库,然后输入名称和介绍;创建完知识库后,我们就可以向知识库中添加文档了,只需要复制之前用Markdown写的文档,然后点击右上角的ConvertNow;转换成功后显示效果如下,是不是比自己搭建项目文档网站好?简单多了?这里值得一提的是,当我们复制文章时,语雀会自动为我们上传在线图片,很多博客网站也有这个功能;如果要修改知识库的文档目录,比如我要整个二级目录,可以使用catalog功能;自定义主页其实就到这里,我们已经学会了如何制作一个开源项目文档网站,但是此时文档网站的主页只是一个目录,显得有些单调。如果我们想让首页的内容更丰富,我需要创建一个团队,然后自定义团队的首页;首先,让我们创建一个团队并选择一个官方文档模板;然后填写姓名、介绍、头像;那么我们就可以通过自定义主页功能来使用一个图形界面来完成一个主页。下面是我完成的首页效果;这里我添加了三个模块:搜索、知识库和自定义内容。如果你想要更丰富的首页,可以添加更多的模块来尝试;最好在你的知识库的设置页面将你的知识库转移到创建的团队;然后访问你的团队主页,一个标准的开源项目文档网站就诞生了。公共访问如果你想搭建一个私有文档网站,以上操作基本可以满足你的需求,但是如果你想搭建一个公共文档网站,则需要进行以下操作。不幸的是,无论是团队还是新创建的空间中的知识库都不能设置为互联网上的每个人都可以访问。仅支持以下三种访问权限;在个人空间,创建知识群时,可以选择官方文档模板;这个时候我们可以发现这个团队的可见范围变成了网络可见,这才是真正的开放团队;接下来要做的就是导入之前的知识库,导出功能调到团队,导出功能在知识库设置->高级设置中,选择导出为.lakebook格式;然后在知识组中创建一个知识库,设置范围为全网可见,并导入.lakebook文件;然后按照前面的步骤自定义知识群的首页,一个可以公开访问的开源项目文档网站就诞生了!总结使用语雀搭建开源项目文档的实践,我们可以发现,这种方式确实比使用Docsify自己搭建网站要简单的多,既不需要写代码,也不需要购买服务器。难怪许多开源项目使用它来构建文档网站。当然,语雀的功能远不止这些。对于在线云笔记也非常有用。有兴趣的可以自己去探索!官网https://www.yuque.com/本文GitHubhttps://github.com/macrozheng/mall-learning已收录,欢迎大家Star!
