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

歡迎訪問 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文件

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

這是最簡單的示例：

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

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

"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命令

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

該步驟僅需要允許一次即可.

gitbook install

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

npm install gitbook-plugin-icp

2. 像往常一樣構建您的書（ 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 以自定義標籤：

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

或者您可以添加 link 以自定義鏈接：

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

注意 ：如果您的書還沒有創建,以上代碼段可以用作完整的book.json文件.

作者

👤 snowdreams1006

• 網站 : snowdreams1006.tech
• GitHub : @snowdreams1006
• 電子郵件 : [email protected]

貢獻

歡迎提供文稿，問題和功能請求！
隨時檢查問題頁面 。

表示支持

如果這個項目對您有幫助，請給個星星 ！

版權

版權所有©2019 snowdreams1006 。

該項目是MIT許可的。

如果你覺得本文對你有所幫助,請隨手點個贊再走唄或者關注下公衆號「雪之夢技術驛站」定期更新優質文章喲!