Honkit插件

配置插件

  • 在book.json中配置插件

  • plugins中配置插件名,pluginsConfig中配置插件信息

  • plugins中插件名前加-,表示取消插件(默认配置了5个插件)

1

安装插件

npm install gitbook-plugin-[插件名]

例如:
```
npm install gitbook-plugin-expandable-chapters-small

```

插件介绍

Gitbook 中默认带有 5 个插件:

名称 说明
highlight 语法高亮插件,代码高亮功能
search 搜索插件,不支持中文搜索
sharing 分享插件,右上角分享功能
font-settings 字体设置(最上方的"A"符号)
livereload 热加载插件,为 GitBook 编辑进行实时重新预览加载

其他插件

  • expandable-chapters-small

    子目录折叠


  • chapter-fold

    子目录折叠,和expandable-chapters-small一起使用


  • get-pdf

    下载pdf按钮

      "get-pdf":{
                  "base": "/summary/assets",
                  "prefix": "book",
                  "label": "下载 PDF"
    
              }
    

    base 文件目录,prefix 文件名,label 下载按钮名称


  • code

    代码块复制按钮+代码行号

      "code":{
                  "copyButtons": true
              }
    

  • search-pro

    搜索栏


  • tbfed-pagefooter

    页脚信息

      "tbfed-pagefooter": {
                  "copyright":"©2023 郑州时空软件有限责任公司",
                  "modify_label": "该文档修订时间:",
                  "modify_format": "YYYY-MM-DD HH:mm:ss"
              }
    

  • popup

    新窗口查看图片


  • theme-skdoc

    网站主题

    
      "variables": {
              "themeSkdoc":{
                  "nav":[
                      {
                          "url":"http://www.baidu.com",
                          "target":"_blank",
                          "name": "F&Q"
                      }
                  ]
              }
      },
    
      "pluginsConfig":{
          "theme-skdoc":{
                      "search-placeholder":"输入关键字搜索",
                      "logo":"./summary/img/sk_logo_colour.png", 
                      "favicon": "./summary/img/ic_logo.png"
                  }
      }
    

    variables 中添加外部链接

    pluginsConfig-theme-skdoc 中配置其他信息


  • hide-element

    隐藏插件的指定元素

      "hide-element": {
                  "elements": [".gitbook-link",""]
              }
    

    取出gitbook标记

©2023 郑州时空软件有限责任公司 all right reserved,powered by Gitbook该文档修订时间: 2023-08-31 13:50:47

results matching ""

    No results matching ""