gitbook 入門教程之網站域名備案 icp 插件

時間 2019-12-21

標籤 gitbook 入門教程網站域名備案 icp 插件欄目 Git 简体版

原文原文鏈接

歡迎訪問 gitbook-plugin-icp 官網 👋

用於在首頁頁腳區域添加 icp 網站備案信息的 Gitbook 插件

🏠 主頁

Github : https://snowdreams1006.github.io/gitbook-plugin-icp/
GitLab: https://snowdreams1006.gitlab.io/gitbook-plugin-icp/
Gitee : https://snowdreams1006.gitee.io/gitbook-plugin-icp/

屏幕截圖

多語言版本

單語言版本

用法

步驟＃1-更新`book.json`文件

在您的 gitbook 的 book.json 文件中，將 icp 添加到 plugins 列表中。
在 pluginsConfig ,將 number 值設置爲您本身的 icp 網站備案編號.
在 pluginsConfig ,label 或 link 值是可選的,默認狀況下,連接地址爲 http://www.beian.miit.gov.cn/ .

這是最簡單的示例：git

{
    "plugins": ["icp"],
    "pluginsConfig": {
        "icp": {
            "number": "浙ICP備18042346號"
        }
    }
}

此外，受支持的配置選項以下：github

"label": {
  "type": "string",
  "title": "icp label",
  "required": false
},
"number": {
  "type": "string",
  "title": "icp number",
  "required": true
},
"link": {
  "type": "string",
  "title": "link url",
  "required": false,
  "default": "http://www.beian.miit.gov.cn/"
}

步驟＃2-gitbook命令

運行gitbook install .它將自動爲您的 gitbook 安裝 icp 插件.

該步驟僅須要容許一次便可.

gitbook install

或者您能夠運行 npm install gitbook-plugin-icp 命令本地安裝 gitbook-plugin-icp 插件.npm

npm install gitbook-plugin-icp

像往常同樣構建您的書（ gitbook build ）或服務（ gitbook serve ）.

gitbook serve

示例

官方文檔配置文件

https://github.com/snowdreams1006/gitbook-plugin-icp/blob/master/docs/book.json

{
    "plugins": ["icp"],
    "pluginsConfig": {
        "icp": {
            "number": "浙ICP備18042346號"
        }
    }
}

官方示例配置文件

https://github.com/snowdreams1006/gitbook-plugin-icp/blob/master/example/book.json

{
    "plugins": ["icp"],
    "pluginsConfig": {
        "icp": {
            "number": "浙ICP備18042346號"
        }
    }
}

示例book.json文件

{
    "plugins": ["icp"],
    "pluginsConfig": {
        "icp": {
            "label": "YOUR OWN ICP LABEL",
            "number": "YOUR OWN ICP NUMBER",
            "link":"YOUR OWN ICP LINK"
        }
    }
}

或者，您能夠添加 label 以自定義標籤：json

{
    "plugins": ["icp"],
    "pluginsConfig": {
        "icp": {
            "label": "YOUR OWN ICP LABEL",
            "number": "YOUR OWN ICP NUMBER",
            "link":"YOUR OWN ICP LINK"
        }
    }
}

或者您能夠添加 link 以自定義連接：segmentfault

{
    "plugins": ["icp"],
    "pluginsConfig": {
        "icp": {
            "label": "YOUR OWN ICP LABEL",
            "number": "YOUR OWN ICP NUMBER",
            "link":"YOUR OWN ICP LINK"
        }
    }
}

注意：若是您的書尚未建立,以上代碼段能夠用做完整的book.json文件.bash