如何在新版的gitbook上写本身的书

前言

以前为了学习QT当中的qmake，就去看QT的官方文档，但QT的官方文档都是英文的，而本身自己英文较差，就一咬牙决定不如就把qmake的使用文档翻译一下吧。这样便可以加深对文档的理解，也能够留着本身之后查阅，顺便也能够将本身的文档放在网上给想要的人进行查阅。因而就开始查找相关的工具，几经展转找到了gitbook这个网站。而后了解其使用方法，但不巧的是网站正处于改版时间，网上找到的教程基本全是针对旧版的，而新版的网站许多功能上尚未完善，这个折磨了我很久。

gitbook上提供了多种编辑文档的方式，能够在线编辑也能够离线编辑后再上传。新版的网站和旧版的网站已经有了好多的改变。具体的改变能够参阅gitbook的网站文档。其中的一种编辑文档的方式就是将文档像代码同样推送到GitHub,而后将文档同步到gitbook。虽然以前我没有用过git也没有用过github，我仍是挺着迷这种编写文档的方式的，so。。。。由于新网站的功能还不算完善，因而各类折腾开始了。。。。之间我也联系了网站的管理员，他们也以邮件的方式回复了我，表达了它们对网站功能不完善的歉意。这里也表示感谢。。。。因而折腾了几天仍是先将对gitbook网站的折腾先暂时搁置了。。。。

继续查阅我还要哪些工具，因而我还要学习Markdown，git以及github的使用。因而学起来。。。。而关于文本编辑器的使用又陷入了纠结。。。再VScode和sublime之间徘徊，最后仍是发现vscode更适合我一些（这里并非说sublime很差）。VScode中能够很方便的预览文档，以及纠正语法错误。

教程

首先咱们须要再在github上建立一个仓储，并在电脑的本地安装git并将github上的仓储同步到本地。新建github仓储以及git的受用的方法能够参阅廖雪峰的git教程。更详细的也能够阅读git的官方教程。vscode和Markdown的使用本身百度就好啦。。。

作完上面的这些你就能够在本地使用vscode编写本身的文档，并将文档同步到github。下面介绍如何将文档同步到gitbook上，并生成一本书。下面就开始吧。。。

对了这里还要提一下，gitbook能够添加一个.gitbook.ymal的文件文件的使用方法能够查阅gitbook的网站文档。

这里咱们先建立一个gitbook帐号，这里推荐直接使用本身的github帐号登录gitbook。咱们按照gitbook的网站文档中的步骤建立一个organization，而后再在organization下建立一个space。

而后按照网站文档创建和GitHub上的仓储进行关联。

按照提示关联本身所须要的仓储就好。

写在最后

gitbook官方文档对.gitbook.yaml文档的模板以下所示。该文件须要放在你GitHub仓储的根目录下，而后经过该文档的设置，使用相对路径指定gitbook下的根目录。这里给出我翻译的书qmake-learn其仓储位置是github qmake-learn

# Root directory to locate the content
# Default is the root directory of the repository.
root: ./

# Files to use as SUMMARY/README.
# (Relative to <root> directory)
structure:
  readme: README.md
  summary: SUMMARY.md

# Redirect urls to specific files (relative to the <root> directory)
redirects:
  previous/page: new-folder/page.md

这里给出我翻译的书qmake-learn其仓储位置是github qmake-learn。其实gitbook中也提供了一些其余的服务和设置。好比将你所写的书的网址绑定到本身的域名当中。自定义书的logo，更改书的网址。具体的使用方法能够看一下网站文档，以及本身摸索一下。

这里还要说一下，因为gitbook是国外的网站要像流畅的在上面写书，仍是要。。。。。不过浏览文档没什么问题。