通过 GitBook 开源框架和 GitHub 私有化部署 Wiki 文档

思路:通过将 Wiki 文档内容的仓库托管在 GitHub 之上,并且将 GitBook 框架的代码放在仓库中 ,然后找一台有 Node.js 环境的服务器,通过简单的几行命令就能部署成功,十分钟内能搞定。从而具备多人协作、版本控制、Markdown 写作、代码高亮、实时更新的特性。

一、效果展示

1、Material Design 中文版(有侧边栏菜单)

2、GitBook Help Center(无侧边栏菜单)

二、功能特性

1、页面美观

主要体现在两个方面:其一,页面的外观,请回头看看上面的效果图。其二,链接的格式,如下:

2、多人协作 & 版本控制

文档内容托管于 GitHub 之上,GitHub 本身就具备 多人协作版本控制 的功能。当然所有的 Git 托管平台都可以,比如说国外的 GitLab、Bitbucket,或者国内的 git.oschina.net、coding.net 都行。

如果希望仓库私有,国外产品推荐 Bitbucket,因为他私有仓库免费,而 GitHub 私有仓库收费。国内的好像私有仓库都免费,在安全性和稳定性方面可能不如 Bitbucket。

3、Markdown 写作

文档内容托管于 GitHub 之上,GitHub 本身就具备 Markdown 写作 的功能。

4、代码高亮

通过 GitBook 的插件能很容易支持代码高亮(这就是站在巨人的肩膀上的好处)。

5、实时更新

通过给 GitHub 仓库配置 webhook 进行 push 时的消息推送,能触发服务器实时更新(服务器上需要些代码)。

6、一键部署

只需要简单的几行命令就部署完毕。

三、所需资源

唯一的一个条件就是,一台支持 Node.js 的服务器(公网和内网服务器都行)。

四、操作手册

详细的操作手册见:http://zitiao.org/deploy/

推荐阅读更多精彩内容

  • Swift版本点击这里欢迎加入QQ群交流: 594119878最新更新日期:18-09-17 About A cu...
    ylgwhyh阅读 22,275评论 7 246
  • 题目 给定一个可能具有重复数字的列表,返回其所有可能的子集 注意事项 子集中的每个元素都是非降序的两个子集间的顺序...
    sunner168阅读 389评论 0 51
  • 2016.08.09 自从两天前得到大学城的餐厅水吧谈不下来的消息,这两天晚上把自己放倒在床上都是难以平静入睡,然...
    冯家家家阅读 85评论 2 1
  • 首先,我需要说明下,写这篇笔记的目的不是告诉读者如何去定位,如何使用工具去定位。 目前使用selenium对web...
    大婶N72阅读 1,913评论 1 2
  • 深邃的咖啡,沉默的琴,高挑的女孩,轻佻的眼神,还有那厚实的呢绒袜,模糊的车灯和冷漠的肩踵,又或是窈窕的圣诞树。它们...
    凉雨生阅读 270评论 2 3
  • 碧水青山空气新, 米酒土鸡有机菜。 最喜乡间文化味, 不羡城市爱农村。
    张津华阅读 81评论 0 0