共计 1843 个字符，预计需要花费 5 分钟才能阅读完成。
之前介绍过几款搭建开源我的项目文档的工具，有 Docsify、VuePress 和 Hexo。这些工具有个共同点，须要一些开发部署的工作，部署根本依赖 Github Pages 或者自建服务器。那么有没有那种开箱即用的工具呢，最近发现很多开源我的项目都用
语雀来搭建文档网站，体验了一把，十分不错，举荐给大家！
SpringBoot 实战电商我的项目 mall（50k+star）地址：https://github.com/macrozheng/mall
语雀简介
语雀 是新一代的云端知识库，能够写出像书一样的我的项目文档，领有业余好用的编辑器（反对 Markdown 转换），不便的团队协同性能。
次要应用场景如下：
- 集体笔记：语雀知识库具备公开公有性能，公有的知识库齐全能够当在线云笔记应用，能够不便咱们记录点滴，积淀常识。
- 专栏博客：如果你不想本人搭建博客网站的话，能够间接生成。
- 我的项目文档：能够多人合作的我的项目文档，你见过没？
- 官网文档：能够作为产品阐明和帮忙手册。
成果展现
咱们先来看下成品成果，开箱即用，界面还是挺不错的！
外围概念
在应用语雀之前，咱们须要对其中的概念有所理解。上面介绍下这些外围概念，而后再展现下对应的界面。
- 首先咱们来看下各个外围概念的关系图，这对了解这些概念很有帮忙：
- 空间：空间相似于公司或组织的概念，在空间中咱们能够治理团队、知识库、常识等内容。
- 团队：空间下的团队能够和你理论组织构造进行挂钩，如部门团队，项目组等。
- 知识库：知识库是常识内容的载体，就好比一本书一样，你能够在知识库里对常识内容进行从新组织和分类。
- 常识：知识库中的内容，能够是文档。
搭建
接下来咱们应用语雀来搭建一个开源我的项目文档，以我的开源电商我的项目 mall 为例。
疾速搭建
- 首先咱们点击左上角创立
空间，用于寄存团队和知识库；
- 而后抉择创立
知识库，因为咱们的知识库次要用于寄存文档，所以抉择文档知识库，而后输出名称、简介即可；
- 创立完知识库之后，咱们就能够在知识库中增加
文档了，间接复制之前应用 Markdown 写的文档即可，而后点击右上角的立刻转换；
- 转换胜利后显示成果如下，是不是比本人搭建我的项目文档网站简略多了？
- 这里值得一提的是，在咱们复制文章时，语雀会主动帮咱们上传在线图片，很多博客网站也都有这个性能；
- 如果你想批改知识库的文档目录的话，比方我想整个二级目录，能够应用
编排目录性能；
自定义首页
其实到这里，咱们曾经学会了如何制作一个开源我的项目文档网站了，然而此时文档网站的首页只是一个目录，这样未免有些枯燥，如果咱们想要首页内容更丰盛些，我就须要创立
团队，而后自定义团队的首页即可；
- 首先咱们来创立个团队，抉择
官网文档模板；
- 而后填写名称、简介、头像即可；
- 而后咱们能够通过
自定义首页性能，应用图形化界面来实现一个首页，上面是我曾经实现好的首页成果；
- 这里我增加了搜寻、知识库、自定义内容三个模块，如果你想首页更丰盛些，能够增加更多模块试试；
- 这里最好在你的知识库的设置页，把你的知识库转移到创立的
团队中去；
- 接下来拜访你的团队主页，一个规范的开源我的项目文档网站就诞生了。
公开拜访
如果你想搭建一个公有的文档网站的话，下面的操作根本能满足需要了，但如果你想搭建一个公开的文档网站的话，还须要如下操作。
- 很遗憾的是，在新建空间中的无论团队还是知识库，都是没法设置让互联网上的所有人拜访的，仅反对如下三种拜访权限；
- 要想团队能够公开拜访，咱们须要在默认的个人空间中，创立
常识小组，能够抉择官网文档模板；
- 此时咱们能够发现，团队的可见范畴变成了
互联网可见，这才是真正公开的团队；
- 之后要做的就是把之前的知识库通过导入、导出性能转移到该团队中去，导出性能在
知识库设置 -> 高级设置中，抉择导出为.lakebook格局；
- 而后在该常识小组中创立知识库，设置范畴为
互联网可见，并导入.lakebook文件；
- 之后再依照之前的步骤自定义常识小组的首页，一个能够公开拜访的开源我的项目文档网站就诞生了！
总结
通过应用语雀搭建开源我的项目文档的一波实际，咱们能够发现这种形式的确比应用 Docsify 来自建网站简略太多了，既不须要编码，也不须要买服务器。怪不得很多开源我的项目都用它来搭建文档网站，当然语雀的性能还不只这些，用来做在线云笔记也挺好用的，如果大家感兴趣的话，能够本人摸索下！
官方网站
https://www.yuque.com/
本文 GitHub https://github.com/macrozheng/mall-learning 曾经收录，欢送大家 Star！