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

gitbook-plugin-icp

用于在首页页脚区域添加 icp 网站备案信息的 Gitbook 插件

主页[1]

• Github : https://snowdreams1006.github.io/gitbook-plugin-icp/[2]
• GitLab: https://snowdreams1006.gitlab.io/gitbook-plugin-icp/[3]
• Gitee : https://snowdreams1006.gitee.io/gitbook-plugin-icp/[4]

屏幕截图

• 多语言版本

icp-multilingual-index-use-preview.png

• 单语言版本

icp-monolingual-index-use-preview.png

用法

步骤＃1-更新book.json文件

1. 在您的 gitbook 的 book.json 文件中，将 icp 添加到 plugins 列表中。
2. 在 pluginsConfig ,将 number 值设置为您自己的 icp 网站备案编号.
3. 在 pluginsConfig ,label 或 link 值是可选的,默认情况下,链接地址为 http://www.beian.miit.gov.cn/[5] .

这是最简单的示例：

<code>{    "plugins": ["icp"],    "pluginsConfig": {        "icp": {            "number": "浙ICP备18042346号"        }    }}/<code>

此外，受支持的配置选项如下：

<code>"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/"}/<code>

步骤＃2-gitbook 命令

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

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

<code>gitbook install/<code>

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

<code>npm install gitbook-plugin-icp/<code>

2. 像往常一样构建您的书（ gitbook build ）或服务（ gitbook serve ）.

<code>gitbook serve/<code>

示例

• 官方文档配置文件

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

<code>{    "plugins": ["icp"],    "pluginsConfig": {        "icp": {            "number": "浙ICP备18042346号"        }    }}/<code>

• 官方示例配置文件

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

<code>{    "plugins": ["icp"],    "pluginsConfig": {        "icp": {            "number": "浙ICP备18042346号"        }    }}/<code>

• 示例book.json文件

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

或者，您可以添加 label 以自定义标签：

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

或者您可以添加 link 以自定义链接：

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

注意 ：如果您的书还没有创建,以上代码段可以用作完整的book.json文件.

作者

snowdreams1006

• 网站 : snowdreams1006.tech[8]
• GitHub : @snowdreams1006[9]
• 电子邮件 : [email protected][10]

贡献

欢迎提供文稿，问题和功能请求！
随时检查问题页面[11] 。

表示支持

如果这个项目对您有帮助，请给个**星星**[12] ！

版权所有 ©2019 snowdreams1006[13] 。

该项目是MIT[14]许可的。

[1]

主页: https://github.com/snowdreams1006/gitbook-plugin-icp#readme

[2]

https://snowdreams1006.github.io/gitbook-plugin-icp/: https://snowdreams1006.github.io/gitbook-plugin-icp/

[3]

https://snowdreams1006.gitlab.io/gitbook-plugin-icp/: https://snowdreams1006.gitlab.io/gitbook-plugin-icp/

[4]

https://snowdreams1006.gitee.io/gitbook-plugin-icp/: https://snowdreams1006.gitee.io/gitbook-plugin-icp/

[5]

http://www.beian.miit.gov.cn/: http://www.beian.miit.gov.cn/

[6]

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

[7]

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

[8]

snowdreams1006.tech: https://snowdreams1006.tech/

[9]

@snowdreams1006: https://github.com/snowdreams1006

[10]

[email protected]: mailto:[email protected]

[11]

问题页面: https://github.com/snowdreams1006/gitbook-plugin-icp/issues

[12]

星星: https://github.com/snowdreams1006/gitbook-plugin-icp

[13]

snowdreams1006: https://github.com/snowdreams1006

[14]

MIT: https://github.com/snowdreams1006/gitbook-plugin-icp/blob/master/LICENSE

閱讀更多 雪之夢技術驛站 的文章

關鍵字: 页脚 插件 入门教程