gitbook-plugin-theme-devdoc

使用方法

安装您的插件使用:

$ npm i -D gitbook-plugin-theme-devdoc

将主题添加到您的图书配置 book.json 或者 book.js中:

{
    "plugins": [
        "theme-devdoc"
    ]
}

配置

整体配置

{
    "plugins": [
        "theme-devdoc"
    ],
    "variables": {
        "themeDevdocs":{
            "nav":[
                {
                    "url": "https://www.baidu.com",
                    "target": "_blank",
                    "name": "百度一下"
                },
                // { ... }
            ]
        },
    },
    "pluginsConfig": {
        "theme-dev-docs":{
            "favicon": "./favicon.ico",
            "logo":"./logo.png",
            "search-placeholder":"输入关键字搜索",
			"copyButtons": true,
			"copyLines": true,
			"dragSplitter": true,
            "hide-elements": [
                ".summary .gitbook-link"
            ]
        }
    }
}

favicon

自定义favicon地址，修改标题栏图标

logo

自定义logo地址，修改logo

search-placeholder

搜索框提示信息

copyButtons

代码块添加复制按钮

copyLines

当显示多行代码时，将添加行号

dragSplitter

在左侧目录和右侧内容之间添加一个可以拖拽的栏，用来调整两边的宽度

hide-elements

隐藏元素，比如导航栏中Published by GitBook

nav

顶部导航栏，nav为数组，将需要的导航添加到变量themeDevdocs中

代码高亮

新增几个代码高亮样式，配合prism插件使用

• prism-atom-dark.css
• prism-ghcolors.css
• prism-vs.css
• prism-xonokai.css

{
    "pluginsConfig": {
        "prism": {
          "css": [
            "gitbook-plugin-theme-devdoc/_themes/prism-xonokai.css"
          ]
        },
    }
}