无需开发部署,秒建优雅的开源项目文档,这个工具用起来贼爽! |
您所在的位置:网站首页 › 开源文档格式怎么设置 › 无需开发部署,秒建优雅的开源项目文档,这个工具用起来贼爽! |
之前介绍过几款搭建开源项目文档的工具,有Docsify、VuePress和Hexo。这些工具有个共同点,需要一些开发部署的工作,部署基本依赖Github Pages或者自建服务器。那么有没有那种开箱即用的工具呢,最近发现很多开源项目都用语雀来搭建文档网站,体验了一把,非常不错,推荐给大家! 语雀简介语雀是新一代的云端知识库,可以写出像书一样的项目文档,拥有专业好用的编辑器(支持Markdown转换),方便的团队协同功能。 主要使用场景如下: 个人笔记:语雀知识库具有公开私有功能,私有的知识库完全可以当在线云笔记使用,可以方便我们记录点滴,沉淀知识。专栏博客:如果你不想自己搭建博客网站的话,可以直接生成。项目文档:可以多人协作的项目文档,你见过没?官方文档:可以作为产品说明和帮助手册。效果展示我们先来看下成品效果,开箱即用,界面还是挺不错的! ![]() 在使用语雀之前,我们需要对其中的概念有所了解。下面介绍下这些核心概念,然后再展示下对应的界面。 首先我们来看下各个核心概念的关系图,这对理解这些概念很有帮助:![]() ![]() ![]() ![]() ![]() 接下来我们使用语雀来搭建一个开源项目文档,以我的开源电商项目mall为例。 快速搭建首先我们点击左上角创建空间,用于存放团队和知识库;![]() ![]() ![]() ![]() ![]() ![]() 其实到这里,我们已经学会了如何制作一个开源项目文档网站了,但是此时文档网站的首页只是一个目录,这样未免有些单调,如果我们想要首页内容更丰富些,我就需要创建团队,然后自定义团队的首页即可; 首先我们来创建个团队,选择官方文档模板;![]() ![]() ![]() ![]() ![]() ![]() 如果你想搭建一个私有的文档网站的话,上面的操作基本能满足需求了,但如果你想搭建一个公开的文档网站的话,还需要如下操作。 很遗憾的是,在新建空间中的无论团队还是知识库,都是没法设置让互联网上的所有人访问的,仅支持如下三种访问权限;![]() ![]() ![]() ![]() ![]() ![]() 通过使用语雀搭建开源项目文档的一波实践,我们可以发现这种方式确实比使用Docsify来自建网站简单太多了,既不需要编码,也不需要买服务器。怪不得很多开源项目都用它来搭建文档网站,当然语雀的功能还不只这些,用来做在线云笔记也挺好用的,如果大家感兴趣的话,可以自己探索下! 官方网站https://www.yuque.com/ 最后到目前为止,我们已经介绍了四种搭建开源项目文档的方式,有Docsify 、VuePress 、Hexo 和本文的语雀,你觉得那种好,来投票看看! |
CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |