首页手记 gitbook 入门教程之网站域名备案 icp 插件

gitbook 入门教程之网站域名备案 icp 插件

标签：

Node.js 前端工具开源

用于在首页页脚区域添加 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/ .

这是最简单的示例：

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

运行gitbook install .它将自动为您的 gitbook 安装 icp 插件.

该步骤仅需要允许一次即可.

gitbook install

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

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 以自定义标签：

{
    "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"
        }
    }
}