支持中文搜索的gitbook

如何安装

fork项目地址: codepiano/gitbook · GitHub

官方仓库地址: GitbookIO/gitbook · GitHub

由于使用的分词插件模块nodejieba,是使用nodejs对c++库的封装,所以安装依赖的时候要求机器上安装有c++编译环境

windows的情况我不了解,linux使用的是g++,mac使用clang ,可能需要安装一下 command line tools ,具体安装方式请google

npm install -g codepiano/gitbook

添加的插件

  1. 集成多说评论,见 codepiano/gitbook-plugin-duoshuo
  2. 集成畅言评论,见 codepiano/gitbook-plugin-changyan

    进行的主要改动

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

        "introduction": {
            "path": "你的介绍文件的路径",
            "title": "你的介绍文件的标题"
        }
        
  7. 可以在目录栏底部添加自定义链接,在book.json中添加配置项

     "tail": {
         "tilte1": "url1",
         "title2": "url2"
     }
     
  8. 不再把google、facebook、twitter分享设置为默认,所有分享需要在配置文件中设置,才会出现在分享栏。

     "links": {
         "sharing": {
             "all"      : true,
             "google"   : true,
             "facebook" : true,
             "twitter"  : true,
             "weibo"    : true,
             "qq"       : true,
             "qrcode"   : true
         }
     }
     
  9. 为了便于SEO,添加了keywords的meta标签,可以在book.json中配置

     "keywords": "keyword1,keyword2,keyword3"
     


—  原创作品许可 — 署名-非商业性使用-禁止演绎 3.0 未本地化版本 — CC BY-NC-ND 3.0   —