书籍配置

本章节包含如下内容:

1，创建
mkdir project //创建project项目文件

cd project    //进入project文件

gitbook init  //初始化文件

发现project文件里多了如下两个文件 ：

|——project
| |——README.md  // 对书籍的具体介绍
| |——SUMMARY.md // 书籍的目录结构
  • README.md

README.md是对本书籍做简介说明的文件；

  • SUMMARY.md

SUMMARY.md是书籍的目录结构配置文件，本书籍的目录结构如下：

* [简介](README.md)
* [环境配置](computer-setting.md)
* [书籍配置](book-config.md)
* [排版语法](grammar.md)
* [结尾](over.md)

多级目录展示

多级目录语法：

* [简介](README.md)
* [环境配置](computer-setting.md)
* [书籍配置](book-config.md)
 - [二级目录](second.md)
    - [三级目录](three.md)
* [排版语法](grammar.md)
* [结尾](over.md)
2，配置

然后手动创建book.json文件(此为配置文件)，放入project根目录下；

book.json（注意json内容格式的校验）:

{
    "title": "XX操作手册",
    "description": "XX操作手册",
    "isbn": "XXXX-XXX-XXXX-X-XXX",
    "author": "ifugle",
    "language": "zh-hans", 
    "direction": "rtl",     // rtl or ltr
    "gitbook": ">= 3.0.0",
    "links": {
      "gitbook": false,
      "sharing": {         // 关闭分享链接
        "google": false,
        "facebook": false,
        "twitter": false,
        "all": false
      }
  }
}

具体配置可查看官方文档：book.json配置

3，启动

本地预览启动服务

gitbook serve   // 可通过http://localhost:4000访问本地

使用build参数可生成静态文件

gitbook build   // 默认生成_book;
4，编辑
  • Gitbook Editor在线编辑器

　　进入Gitbook Editor官网，下载gitbook editor在线编辑器，通过在线编辑器可打开项目文件进行编辑，保存，发布(发布前要注册gitbook)；

  • 使用其它编辑器

　　常用的代码编辑器WebStorm、sublime、VSCode等；

  • 注意事项

　　Gitbook Editor在线编辑配合其它编辑器使用的情况下，请先打开Gitbook Editor在线编辑器后再使用其它编辑器编辑保存，避免被Gitbook Editor在线编辑器的历史记录代码覆盖掉。

5，中文及搜索
  • 文档中文语言设置

book.json中设置

{
  "language": "zh-hans",  //支持中文，英文为："en"
}
  • 支持中文搜索

　　支持全局中文搜索并显示搜索关键字高亮；需要安装插件“gitbook-plugin-search-pro”，可通过在book.json中配置以后再执行gitbook install

// book.json增加搜索配置如下
{
 "plugins": [
      "-lunr",   // 禁用为搜索提供后台编译器(backend)
      "-search", // 禁用默认搜索
      "splitter",  //实现左侧目录与右侧内容之间的宽度拖拽
      "-search-plus", // 禁用-search-plus搜索插件，去掉前面的“-”就是支持
      "search-pro"
    ]
}

然后通过如下命令执行(不要通过全局安装gitbook-plugin-search-pro)：

gitbook install
Thanks

results matching ""

    No results matching ""