<commit_before>GitBook
=======

可以点击下面的按钮进入gitter聊天室，有问题可以在里面问

[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/codepiano/gitbook?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## 例子

[参考示例](http://www.wiz.cn/manual/windows/)

[示例源文件](https://github.com/codepiano/wiz-manual)

## 如何安装

由于使用的分词插件模块[nodejieba](https://github.com/aszxqw/nodejieba)，是使用nodejs对c++库的封装，所以安装依赖的时候要求机器上安装有c++编译环境

windows的情况我不了解，linux使用的是g++

linux使用包管理工具安装，mac可能需要安装一下 command line tools ，具体安装方式请google

```shell
npm install -g codepiano/gitbook
```

## 进行的主要改动

1. 支持中文搜索
    需要生成所有文章内容的json格式索引文件，内容过多的话需要注意文件的体积，开启压缩的话应该不会造成太大的负担
1. 支持搜索后关键字高亮
1. 支持分享到qq、微信（二维码）
    + 分享到qq直接跳转至qq connect分享页面，该页面也可实现分享到qq空间和qq微博的功能
    + 分享到微信直接生成二维码，也可分享到其他平台
    + 需要在配置文件中设置相关选项为true
1. 修改了介绍页面（即生成网站的主页）的方式，增加了一个新的指定方式
    + 原始的gitbook介绍页面文件名必须为README.md，只可以自定义标题名称
    + 修改后可以在配置文件book.json中指定介绍页面的标题和文件(相对)路径，可以不在SUMMARY.md文件中指定，在book.json中添加<commit_msg>remove old example<commit_after>GitBook
=======

可以点击下面的按钮进入gitter聊天室，有问题可以在里面问

[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/codepiano/gitbook?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## 例子

[示例](https://github.com/codepiano/wiz-manual)

## 如何安装

由于使用的分词插件模块[nodejieba](https://github.com/aszxqw/nodejieba)，是使用nodejs对c++库的封装，所以安装依赖的时候要求机器上安装有c++编译环境

windows的情况我不了解，linux使用的是g++

linux使用包管理工具安装，mac可能需要安装一下 command line tools ，具体安装方式请google

```shell
npm install -g codepiano/gitbook
```

## 进行的主要改动

1. 支持中文搜索
    需要生成所有文章内容的json格式索引文件，内容过多的话需要注意文件的体积，开启压缩的话应该不会造成太大的负担
1. 支持搜索后关键字高亮
1. 支持分享到qq、微信（二维码）
    + 分享到qq直接跳转至qq connect分享页面，该页面也可实现分享到qq空间和qq微博的功能
    + 分享到微信直接生成二维码，也可分享到其他平台
    + 需要在配置文件中设置相关选项为true
1. 修改了介绍页面（即生成网站的主页）的方式，增加了一个新的指定方式
    + 原始的gitbook介绍页面文件名必须为README.md，只可以自定义标题名称
    + 修改后可以在配置文件book.json中指定介绍页面的标题和文件(相对)路径，可以不在SUMMARY.md文件中指定，在book.json中添加
{'fraction_non_alphanumeric': 0.12768184196755625, 'fraction_numerical': 0.004186289900575615, 'mean_word_length': 7.101694915254237, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1388998', 'n_tokens_mistral': 1264, 'n_tokens_neox': 1394, 'n_words': 72}