gitbook联动github

什么是gitbook？

gitbook是一个现代的分布式在线文档编辑工具，它支持markdown文件，可以将内容导出成pdf，也可以通过网址直接访问文档内容。

文档推荐

官方英文文档

中文文档

是什么是github?

github是一个远程的代码托管git仓库，github上面有着非常多的开源项目，如spring，mybatis等。我们在本地可以使用git命令，从远程仓库进行拉取，推送，合并分支等操作。

文档简单编写

gitbook支持的功能非常多，如多语言，插件，搜索，赞赏等功能。博主这里先简单的使用一下gitbook的目录结构，并用文档内容是使用的markdown格式。

目录结构

目录结构，就相当于我们网站中的菜单。通过菜单我们可以非常方便的进行文档的查看。要展现出目录结构，我们就需要编写一个SUMMARY.md文件。

<!--摘要，实际上不会显示>
# Summary

<!--一级目录-->
  * [介绍](README.md)
  * [数据结构](/dataStructure/README.md)
<!--二级目录-->
	  * [二叉树](/dataStructure/binaryTree.md)
  * [Maven](/maven/README.md)
	  * [搭建maven仓库](/maven/nexus.md)
<!--分割线-->
---
* [关于作者](personalIntroduction.md)

怎么联动？

博主这里直接使用的gitbook站点来生成我们的文档，而不是自己进行文档站点的搭建。

联动逻辑

我们首先将github作为markdown文件的托管仓库，然后对其进行修改操作时，gitbook会接受到对应的消息，从github拉取代码然后重新生成页面。

联动配置

开始集成，这里我们选择github集成。

这里我们选择共有项目。

这里我们选择同步master分支。

这里我们选择的第一种同步模式，也就是使用github作为内容的托管，然后同步到gitbook作为内容的展示。

查看对外访问地址

gitbook给我们提供了二级域名进行访问，如图查看对外访问地址。

查看结果

最后一步，通过上面的访问地址，我们就可以看到我们自己的文章了。

博主微信公众号