book.json详细配置

1. 结构

{
        "title": "Tmiracle的博客文档",
        "description": "Tmiracle's Blog Docs",
        "author": "Tmiracle",
        "output.name": "site",
        "language": "zh-hans",
        "gitbook": "3.2.3",
        "root": ".",
        "plugins": [
            "donate",
            "-lunr",
            "-search",
            "-highlight",
            "-sharing",
            "github"
        ],
        "pluginsConfig": {
            "github": {
                "url": "https://github.com/ImTmiracle/ImTmiracle.github.io"
            }
        }
    }
字段 属性
title 浏览器显示标题
description 浏览器显示描述
author 作者标识
output.name 输出方式
language 语言标识
gitbook 版本标识
root 路径标识
plugins 插件
pluginsConfig 相应插件配置

2. 推荐插件

点我查看更详细的配置

  • -lunr 去除默认识别引擎

  • -search 去除默认搜索引擎

  • -highlight 去除默认代码高亮

  • -sharing 去除默认分享按钮

  • sharing-plus 分享按钮加强版

    pluginsConfig中添加详细配置:

"sharing": {
    "douban": false,    ---启用豆瓣
    "facebook": false,      ---启用脸书
    "google": false,      ---启用谷歌
    "hatenaBookmark": false,    ---启用hatenaBookmark
    "instapaper": false,    ---启用instapaper
    "line": false,      ---启用line
    "linkedin": false,      ---启用linkedin
    "messenger": false,     ---启用messenger
    "pocket": false,        ---启用pocket
    "qq": true,     ---启用QQ
    "qzone": true,      ---启用QQ空间
    "stumbleupon": false,       ---启用stumbleupon
    "twitter": false,       ---启用推特
    "viber": false,     ---启用viber
    "vk": false,        ---启用vk
    "weibo": true,      ---启用新浪微博
    "whatsapp": false,      ---启用whatsapp
    "all": [
        "facebook",
        "google",
        "twitter",
        "instapaper",
        "linkedin",
        "pocket",
        "stumbleupon"
    ]
}
  • search-pro 搜索加强版(中文搜索引擎,搜索优化)

  • search-plus 中文搜索(不好用,推荐用search-pro)

  • hide-element 隐藏目录左下角的文字

    pluginsConfig中添加详细配置:

"hide-element": {
    "elements": [
        ".gitbook-link"
    ]
}
  • expandable-chapters 折叠目录(多层目录,点击箭头自动展开)

  • chapter-fold 折叠目录(多层折叠,点击标题自动展开,有箭头(建议使用这个))

  • toggle-chapters 折叠目录(多层折叠,点击标题自动展开,无箭头)

  • collapsible-menu 折叠目录(多层折叠,点击标题自动展开,无箭头)

  • expandable-chapters-small 折叠目录(多层目录,mini箭头,点击箭头自动展开)

  • accordion 折叠目录(2019.9.1记录:无法使用)

  • github-buttons github按钮(添加项目在 github 上的 star,watch,fork情况)

    pluginsConfig中添加详细配置:

"pluginsConfig": {
    "github-buttons": {
        "repo": "xxx/gitbook-use",      ---github仓库地址
        "types": [      ---显示图标
            "star",
            "watch",
            "fork"
        ],
        "size": "small"     ---尺寸
    }
}
  • donate 打(tao)赏(fan)按钮

    pluginsConfig中添加详细配置:

"donate": {
    "wechat": "",       ---微信二维码地址
    "alipay": "",       ---支付宝二维码地址
    "title": "",        ---按钮边的文字
    "button": "",      ---按钮上的文字
    "alipayText": "",       ---支付宝二维码下的文字
    "wechatText": ""        ---微信二维码下的文字
}
  • github github仓库链接

    pluginsConfig中添加详细配置:

"github": {
            "url": "https://github.com/ImTmiracle/ImTmiracle.github.io" ---仓库地址
        }
  • prism 代码块主题配色插件 和 prism-themes 代码块主题配色方案

    prism和prism-themes需要同时使用,主题地址: 传送门

    pluginsConfig中添加详细配置:

"prism": {
    "css": [
        "prism-themes/themes/prism-<your theme>.css"
    ]
}
  • custom-favicon 浏览器标签logo

    pluginsConfig中添加详细配置:

"favicon": "icon/favicon.ico"   ---必须是.ico
  • insert-logo 左上角个人头像

    pluginsConfig中添加详细配置:

"insert-logo": {
    "url": "/icon/logo.png",        ---图片地址
    "style": "background: none; max-height: 90px; min-height: 90px"     ---图片样式
}
  • code markdown代码块复制按钮

  • pageview-count 文章阅读数统计

  • lightbox 弹层显示图片

  • popup 新窗口查看图片(建议使用lightbox)

  • splitter 侧边栏宽度调节

  • tbfed-pagefooter 页脚(最后修改时间显示)

    pluginsConfig中添加详细配置:

"tbfed-pagefooter": {
    "copyright": "copyright &copy Tmiracle",
    "modify_label": "该文件最后修改时间:",
    "modify_format": "YYYY-MM-DD HH:mm:ss"
}
  • anchor-navigation-ex-toc 添加Toc到侧边悬浮导航以及回到顶部按钮(增强版)

    pluginsConfig中添加详细配置:

"anchor-navigation-ex-toc": {
    "showLevel": true,      ---展示级别
    "associatedWithSummary": true,      ---目录关联
    "printLog": false,      ---打印日志
    "multipleH1": false,
    "mode": "float",
    "showGoTop": true,      ---展示回到顶部按钮
    "float": {
        "floatIcon": "fa fa-navicon",
        "showLevelIcon": true,
        "level1Icon": "fa fa-hand-o-right",
        "level2Icon": "fa fa-hand-o-right",
        "level3Icon": "fa fa-hand-o-right"
    },
    "pageTop": {
        "showLevelIcon": true,
        "level1Icon": "fa fa-hand-o-right",
        "level2Icon": "fa fa-hand-o-right",
        "level3Icon": "fa fa-hand-o-right"
    }
}
  • anchor-navigation-ex 添加Toc到侧边悬浮导航以及回到顶部按钮

  • back-to-top-button 回到顶部按钮

copyright © Tmiracle all right reserved,powered by Gitbook该文件最后修改时间: 2019-12-11 00:55:33

results matching ""

    No results matching ""