gitbook使用

前言

最近在英文文档中游离，不断的吸取协议规范的点点滴滴。发现还是有一点儿费劲的，在阅读的同时自然少不了做一些笔记。以往的经验，都是在word或者txt文档里面，记录一下自己感觉比较重要的点，同时在记录的过程中增加理解。阅读文档和阅读代码，我都是这样子做的。相信大多数程序员也都差不多吧。

了解一个新的领域，首先是看网络上关于这个领域的介绍，让自己对这个领域有初步的理解。然后就是快速阅读官方关于这个领域制定的文档，对其内容有一个全局的理解。再者就是去看代码了，先看一下代码相关的README, 然后结合着文档对代码进行学习。每一步都可以做一下笔记，同时记录一下自己的疑问和心得、想法，以便在后续的学习中按图索骥，加深对细节的理解和掌握。

最近开始netconf一系列规范的学习，首先是多个RFC文档的阅读。相关的RFC比较多，使用以往的经验学习，感觉有点儿杂乱无章的感觉。在网络上找到一些博客，发现他们通过gitbook的使用，把不同的RFC阅读笔记整理出来，这是一个不错的实践。这不，我也开始了解一下gitbook的使用，打算也这么干。

gitbook

gitbook介绍的话不多说， 在网络上可以搜到很多gitbook的教程。这里就记录一下自己搭建gitbook到博客上的想法及步骤。

参照他人的做法，在博客上添加一个gitbook的标签，指向一个总的gitbook的索引页面。 这个索引页面是markdown写的，权重改小一点，让他不会置顶，可以通过标签访问到。

针对每个RFC或者其他协议的文档笔记，都在一个新的统一git仓库中创建，每个占用一个顶级目录。生成的html文档拷贝到博客的一个gitbook的目录下，这个目录不需要渲染。

安装、创建

安装gitbook

$ npm install gitbook -g

使用

mkdir RFC7950
cd RFC7950
gitbook init

// write notes

gitbook serve

拷贝’_book’目录到source下的gbook目录下，修改目录名称为具体的主题名（注意：这里主题名不能以下划线开头，否则会被忽略掉，不被拷贝到public目录），如 rfc7950。

skip_render 添加 gbook/**/*

去除自带插件
Gitbook 默认带有 5 个插件：

• highlight
• search
• sharing
• font-settings
• livereload

// book.json
"plugins": [
    "-search"
]

嗯，这样简单的gitbook集成pages就可以。

行动，才不会被动!

欢迎关注个人公众号 微信 -> 搜索 -> fishmwei，沟通交流。