{"id":21461567,"url":"https://github.com/snowdreams1006/gitbook-plugin-icp","last_synced_at":"2026-01-04T02:02:37.790Z","repository":{"id":57251162,"uuid":"228751866","full_name":"snowdreams1006/gitbook-plugin-icp","owner":"snowdreams1006","description":"gitbook plugin for adding icp info to footer","archived":false,"fork":false,"pushed_at":"2024-08-15T06:41:19.000Z","size":1683,"stargazers_count":4,"open_issues_count":3,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-23T20:06:38.973Z","etag":null,"topics":["gitbook-plugin","icp","supervision","website"],"latest_commit_sha":null,"homepage":"https://snowdreams1006.github.io/gitbook-plugin-icp/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/snowdreams1006.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-18T03:40:58.000Z","updated_at":"2024-08-15T06:41:23.000Z","dependencies_parsed_at":"2022-08-24T16:52:02.155Z","dependency_job_id":null,"html_url":"https://github.com/snowdreams1006/gitbook-plugin-icp","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-icp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-icp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-icp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-icp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snowdreams1006","download_url":"https://codeload.github.com/snowdreams1006/gitbook-plugin-icp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243976503,"owners_count":20377692,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gitbook-plugin","icp","supervision","website"],"created_at":"2024-11-23T07:09:47.429Z","updated_at":"2026-01-04T02:02:37.739Z","avatar_url":"https://github.com/snowdreams1006.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Welcome to gitbook-plugin-icp 👋\n\n[![npm:version](https://img.shields.io/npm/v/gitbook-plugin-icp.svg)](https://www.npmjs.com/package/gitbook-plugin-icp)\n[![npm:download](https://img.shields.io/npm/dt/gitbook-plugin-icp.svg)](https://www.npmjs.com/package/gitbook-plugin-icp)\n[![npm:prerequisite](https://img.shields.io/badge/gitbook-*-blue.svg)](https://www.npmjs.com/package/gitbook-plugin-icp)\n[![github:documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://github.com/snowdreams1006/gitbook-plugin-icp#readme)\n[![github:maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/snowdreams1006/gitbook-plugin-icp/graphs/commit-activity)\n[![npm:license](https://img.shields.io/npm/l/gitbook-plugin-icp.svg)](https://github.com/snowdreams1006/gitbook-plugin-icp/blob/master/LICENSE)\n[![github:snodreams1006](https://img.shields.io/badge/github-snowdreams1006-brightgreen.svg)](https://github.com/snowdreams1006)\n[![微信公众号:雪之梦技术驿站-brightgreen.svg](https://img.shields.io/badge/%E5%BE%AE%E4%BF%A1%E5%85%AC%E4%BC%97%E5%8F%B7-%E9%9B%AA%E4%B9%8B%E6%A2%A6%E6%8A%80%E6%9C%AF%E9%A9%BF%E7%AB%99-brightgreen.svg)](https://snowdreams1006.github.io/snowdreams1006-wechat-public.jpeg)\n\n\u003e gitbook plugin for adding icp info to footer\n\n## Usage\n\n### Step #1 - Update `book.json` file\n\n1. In you gitbook's `book.json` file, add `icp` to `plugins` list.\n2. In `pluginsConfig`,Set the `number` value to your own icp.\n3. In `pluginsConfig`,`label` or `link` value is NOT required.By default link url will be [http://www.beian.miit.gov.cn/](http://www.beian.miit.gov.cn/).\n\nHere is simplest example :\n\n```json\n{\n    \"plugins\": [\"icp\"],\n    \"pluginsConfig\": {\n        \"icp\": {\n            \"number\": \"浙ICP备18042346号\"\n        }\n    }\n}\n```\n\nIn addition, the supported configuration options are as follows : \n\n```json\n\"gitbook\": {\n  \"properties\": {\n    \"label\": {\n      \"type\": \"string\",\n      \"title\": \"icp label\",\n      \"required\": false\n    },\n    \"number\": {\n      \"type\": \"string\",\n      \"title\": \"icp number\",\n      \"required\": true\n    },\n    \"link\": {\n      \"type\": \"string\",\n      \"title\": \"link url\",\n      \"required\": false,\n      \"default\": \"http://www.beian.miit.gov.cn/\"\n    },\n    \"style\": {\n      \"type\": \"object\",\n      \"title\": \"icp number style\",\n      \"required\": false\n    }\n  }\n}\n```\n\n### Step #2 - gitbook commands\n\n1. Run `gitbook install`. It will automatically install `icp` gitbook plugin for your book. This is needed only once.\n\n```bash\ngitbook install\n```\n\nor you can run `npm install gitbook-plugin-icp` to install locally.\n\n```bash\nnpm install gitbook-plugin-icp\n```\n\n2. Build your book (`gitbook build`) or serve (`gitbook serve`) as usual.\n\n```bash\ngitbook serve\n```\n\n## Example\n\n- Sample `book.json` file \n\n```json\n{\n    \"plugins\": [\"icp\"],\n    \"pluginsConfig\": {\n        \"icp\": {\n            \"number\": \"YOUR OWN ICP NUMBER\"\n        }\n    }\n}\n```\n\nor you can add `label` to custom your label:\n\n```json\n{\n    \"plugins\": [\"icp\"],\n    \"pluginsConfig\": {\n        \"icp\": {\n            \"label\": \"YOUR OWN ICP LABEL\",\n            \"number\": \"YOUR OWN ICP NUMBER\"\n        }\n    }\n}\n```\n\nor you can add `link` to custom your link:\n\n```json\n{\n    \"plugins\": [\"icp\"],\n    \"pluginsConfig\": {\n        \"icp\": {\n            \"label\": \"YOUR OWN ICP LABEL\",\n            \"number\": \"YOUR OWN ICP NUMBER\",\n            \"link\":\"YOUR OWN ICP LINK\"\n        }\n    }\n}\n```\n\nor you can add `style` to custom your style of number:\n\n```json\n{\n    \"plugins\": [\"icp\"],\n    \"pluginsConfig\": {\n        \"icp\": {\n            \"label\": \"YOUR OWN ICP LABEL\",\n            \"number\": \"YOUR OWN ICP NUMBER\",\n            \"link\": \"YOUR OWN ICP LINK\",\n            \"style\": {\n              \"color\":  \"#f72b07\"\n            }\n        }\n    }\n}\n```\n\n**Note**: Above snippet can be used as complete `book.json` file, if your book doesn't have one yet.\n\n## Author\n\n👤 **snowdreams1006**\n\n- Website: [snowdreams1006.tech](https://snowdreams1006.tech/)\n- Github: [@snowdreams1006](https://github.com/snowdreams1006)\n- Email: [snowdreams1006@163.com](mailto:snowdreams1006@163.com)\n\n## Contributing\n\nContributions, issues and feature requests are welcome!\u003cbr /\u003eFeel free to check [issues page](https://github.com/snowdreams1006/gitbook-plugin-icp/issues).\n\n## Show your support\n\nGive a [**Star**](https://github.com/snowdreams1006/gitbook-plugin-icp) if this project helped you!\n\n![snowdreams1006-wechat-donate.jpg](https://snowdreams1006.github.io/snowdreams1006-wechat-donate.jpg)\n\n## Copyright\n\nCopyright © 2019 [snowdreams1006](https://github.com/snowdreams1006).\n\nThis project is [MIT](https://github.com/snowdreams1006/gitbook-plugin-icp/blob/master/LICENSE) licensed.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnowdreams1006%2Fgitbook-plugin-icp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnowdreams1006%2Fgitbook-plugin-icp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnowdreams1006%2Fgitbook-plugin-icp/lists"}