# test-book

**Repository Path**: xiaonqedu/test-book

## Basic Information

- **Project Name**: test-book
- **Description**: 快速使用playbook写书、记笔记
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-12-15
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 项目说明

由于gitbook中有大量插件，每次使用如果都下载配置过于繁琐

为了以后使用方便这里已经安装好了，gitbook常用插件

使用时进需要拉取代码直接添加内容，十分方便，下面是一些基本命令

```python
C:\Users\tom>  cd C:\aa\test-book            # 进入要进行书写的空文件夹
C:\aa\test-book>  gitbook init               # 初始化文件夹
C:\aa\test-book>  gitbook serve --port 80    # 在本地80端口运行gitbook这个服务
C:\aa\test-book>  gitbook build              # 将项目打包成html文件到gitbook文件夹中
http://localhost:4000/                       # 在浏览器中访问
```

# 项目中已安装gitbook插件

下面是其中使用的插件

```python
{
    "plugins": [
        "splitter",              # splitter 侧边栏宽度可调节
        "copy-code-button",      # 快速复制按钮
        "highlight",             # 代码高亮
        "accordion",             # 折叠模块(页面内容可折叠)
        "back-to-top-button",    # 回到顶部按钮
        
        "search-pro",            # search-pro支持中文搜索，在使用此插件之前，需要将默认的search和lunr 插件去掉
        "-search",         
        "-lunr",
        
        "chapter-fold",                   # 左侧目录可折叠
        "expandable-chapters",            # 也是左侧目录折叠的插件，不同的是可以解决chapter-fold插件的bug
        "-expandable-chapters-small",     # 也是折叠菜单的，但是这个插件跟chapter-fold有一样的bug

        "fontsettings",
        "livereload",            # 为GitBook实时重新加载
        "popup",                 # 打开新的页面查看图片
        
        "-sharing",              # 去掉左右分享功能
        "theme-default",
        "theme-comscore",        # 主题插件，修改标题和表格颜色
        "page-treeview"          # 在页面顶部显示目录

    ],

    "styles": {
        "website": "styles/website.css"
    }
}
```

# 基本效果图

![1576422070664](assets/1576422070664.png)

# 目录结构说明

```python
C:\aa\test-book>tree /F
C:.
│  book.json            # 设置gitbook插件
│  README.md            # gitbook介绍
│  SUMMARY.md           # gitbook目录结构
│
├─styles
│      website.css      # 设置样式
│
├─chapter1              # 第一章文件夹
│      chapter1.md          # 第一章文件
│      section1.md
│      section2.md
│      section3.md
│
├─chapter2              # 第二章文件夹
│      chapter2.md          # 第二章文件
│      section1.md
│      section2.md
│      section3.md
│
├─chapter3              # 第三章文件夹
│      chapter3.md          # 第三章文件
│      section1.md
│      section2.md
│      section3.md
```

#  由于gitbook 3.x版本bug导致build后文件无法自动跳转页面

```python
# 由于代码是压缩后的，会没有空格，搜索的时候可以直接搜索： if(m)for(n.handler&&
# 将if(m)改成if(false)
```