装置

装置命令:1

npm install -g gitbook-cli test

装置实现之后,你能够应用上面的命令来测验是否装置胜利。

$ gitbook -VCLI version: 2.3.2GitBook version: 3.2.3

应用

  • 初始化 gitbook init
    GitBook 筹备工作做好之后,咱们进入一个你要写书的目录,输出如下命令。

    $ gitbook initwarn: no summary file in this bookinfo: create README.mdinfo: create SUMMARY.mdinfo: initialization is finished

    能够看到他会创立 README.md 和 SUMMARY.md 这两个文件,README.md 应该不生疏,就是阐明文档,而 SUMMARY.md 其实就是书的章节目录,其默认内容如下所

    # Summary
如果曾经初始化,间接启动即可- `启动本地服务 gitboook serve`  接下来,咱们输出 `$ gitbook serve` 命令,而后在浏览器地址栏中输出 `http://localhost:4000`- 新建目录首先咱们来看一下gitbook目录构造及相干文件book.json     次要寄存配置信息  {  "plugins": [    "collapsible-menu",    "anchor-navigation-ex",    "tbfed-pagefooter",    "disqus"  ],  "title": "公布业务逻辑梳理",  "pluginsConfig": {      "tbfed-pagefooter": {          "copyright":"Copyright &copy ershouche-FE 2019",          "modify_label": "文件订正工夫:",          "modify_format": "YYYY-MM-DD HH:mm:ss"      },      "disqus": {        "shortName": "gitbookuse"      }  }  }SUMMARY.md  Gitbook 的章节目录![image](https://tva1.sinaimg.cn/large/007S8ZIlly1ggyrd129scj30ng0do41n.jpg)新增目录文件时执行gitbook init会主动创立文件到对于目录上面  留神:  最顶层的是一级目录,缩进一次的是二级目录,默认会膨胀进对应的一级目录外面,如果想创立更深层次的目录构造,就在对应的子目录上面以缩进的形式创立  该文件外面的缩进对于文档侧边栏目录的缩进<img src="https://img.58cdn.com.cn/escstatic/fecar/pmuse/publish/fabu.png" width="200" />- 构建gitbook build  执行该命令会生成一个_book文件夹,外面的内容对于生成的HTML文件## 配置book.json### 配置阐明|     变量      |                             形容                             || :-----------: | :----------------------------------------------------------: ||     root      |       蕴含所有图书文件的根文件夹的门路,除了 book.json       ||   structure   |              指定自述文件,摘要,词汇表等的门路              ||     title     | 您的书名,默认值是从 README 中提取进去的。在 GitBook.com 上,这个字段是预填的。 ||  description  | 您的书籍的形容,默认值是从 README 中提取进去的。在 GitBook.com 上,这个字段是预填的。 ||    author     |         作者名。在GitBook.com上,这个字段是预填的。          ||     isbn      |                      国际标准书号 ISBN                       ||   language    | 本书的语言类型 —— [ISO code](https://links.jianshu.com/go?to=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FList_of_ISO_639-1_codes) 。默认值是 `en` ||   direction   | 文本浏览程序。能够是 rtl (从右向左)或 ltr (从左向右),默认值依赖于 language 的值。 ||    gitbook    |    应该应用的GitBook版本,并承受相似于 `>=3.0.0` 的条件。    ||     links     |                   在左侧导航栏增加链接信息                   ||    plugins    | 要加载的插件列表([官网插件列表](https://links.jianshu.com/go?to=https%3A%2F%2Fdocs.gitbook.com%2Fv2-changes%2Fimportant-differences%23plugins)) || pluginsConfig |                          插件的配置                          |### 默认插件- highlight - 语法高亮插件- search - 搜寻插件- sharing - 分享插件- font-settings - 字体设置插件- livereload - 热加载插件搜寻  ![image-20200716145919634](https://tva1.sinaimg.cn/large/007S8ZIlly1ggstn51gezj30fy04gt8q.jpg)  字体  ![image-20200716145955656](https://tva1.sinaimg.cn/large/007S8ZIlly1ggstnprwzij30b205wwel.jpg)    分享  ![image-20200716150040280](https://tva1.sinaimg.cn/large/007S8ZIlly1ggstoianbfj308006zt8t.jpg)  ### 删除默认插件在平时开发中比方分享给出的都是一些国外的社交网站 对于咱们没太大用户 那么咱们能够删除默认配置在插件配置在加`-`,配置完执行`gitbook install`即可plugins: [  "-sharing"]成果如下:  ![image-20200716150604078](https://tva1.sinaimg.cn/large/007S8ZIlly1ggstu43pr7j31qo0icwgl.jpg)  右侧不再展现分享相干的按钮### 罕用配置#### 代码复制"plugins": [  "code"]成果如下:  ![image-20200720142753077](https://tva1.sinaimg.cn/large/007S8ZIlly1ggxf7nx56kj317q06sjru.jpg)  代码复制按钮"plugins": [  "copy-code-button"]![image-20200720144333351](https://tva1.sinaimg.cn/large/007S8ZIlly1ggxfnx31w6j318607cjrw.jpg)#### 目录折叠"plugins": [  "expandable-chapters"]成果如下:  ![image-20200720142951146](https://tva1.sinaimg.cn/large/007S8ZIlly1ggxf9o7rq1j30cm0bcaap.jpg)  "plugins": [  "expandable-chapters-small"]和下面一样都是折叠目录的,区别就是上面的箭头要细一些。成果如下:  ![image-20200720143153085](https://tva1.sinaimg.cn/large/007S8ZIlly1ggxfbrr8ugj30g20egwfe.jpg)  #### 回到顶部"plugins": [  "back-to-top-button"]成果如下:  ![image-20200720143530843](https://tva1.sinaimg.cn/large/007S8ZIlly1ggxffk1906j31gu0g40v0.jpg)#### 高级搜寻去除默认的search搜寻和lunr,在搜寻后果中,关键字会高亮;自带的 search 插件,关键字不会高亮"plugins": [        "-lunr",         "-search",         "search-pro"  ]原生搜寻成果:  ![image-20200720144425681](https://tva1.sinaimg.cn/large/007S8ZIlly1ggxfotz6s0j31ye0jggro.jpg)高级搜寻:  ![image-20200720144917280](https://tva1.sinaimg.cn/large/007S8ZIlly1ggxftwiu0kj320s0ri12z.jpg)搜寻关键字高亮,反对中文、拼音和英文#### 分享分享以后页面,比默认的 sharing 插件多了一些分享形式"plugins": ["-sharing", "sharing-plus"],  "pluginsConfig": {      "sharing": {           "douban": false,           "facebook": false,           "google": true,           "pocket": false,           "qq": false,           "qzone": true,           "twitter": false,           "weibo": true,        "all": [             "douban", "facebook", "google", "instapaper", "linkedin","twitter", "weibo",              "messenger","qq", "qzone","viber","whatsapp"         ]     }参数配置外面true的默认展现图标,false的默认不展现;all外面的会在分享按钮的下拉列表外面全副展现进去。成果如下:  ![image-20200720145713703](https://tva1.sinaimg.cn/large/007S8ZIlly1ggxg25dfstj30ie0s8wg1.jpg)分享成果如下:  ![image-20200720145824437](https://tva1.sinaimg.cn/large/007S8ZIlly1ggxg3dey89j315a0totcl.jpg)#### 配置页脚"plugins": [     "tbfed-pagefooter"  ],  "pluginsConfig": {      "tbfed-pagefooter": {          "copyright":"Copyright &copy mine 2000-2020",          "modify_label": "文件订正工夫:",          "modify_format": "YYYY-MM-DD HH:mm:ss"      }  }成果如下:  ![image-20200720152236897](https://tva1.sinaimg.cn/large/007S8ZIlly1ggxgskey19j318q03ijrs.jpg)