README

Welcome to gitbook-plugin-icp 👋

gitbook plugin for adding icp info to footer

English | 中文

🏠 Homepage

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

Screenshot

multilingual

monolingual

Usage

Step #1 - Update `book.json` file

In you gitbook's book.json file, add icp to plugins list.
In pluginsConfig,Set the number value to your own icp.
In pluginsConfig,label or link value is NOT required.By default link url will be http://www.beian.miit.gov.cn/.

Here is simplest example :

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

In addition, the supported configuration options are as follows :

"gitbook": {
  "properties": {
    "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/"
    },
    "style": {
      "type": "object",
      "title": "icp number style",
      "required": false
    }
  }
}

Step #2 - gitbook commands

Run gitbook install. It will automatically install icp gitbook plugin for your book. This is needed only once.

gitbook install

or you can run npm install gitbook-plugin-icp to install locally.

npm install gitbook-plugin-icp

Build your book (gitbook build) or serve (gitbook serve) as usual.

gitbook serve

Example

Official documentation configuration file

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

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

Official example configuration file

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

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

Sample book.json file

{
    "plugins": ["icp"],
    "pluginsConfig": {
        "icp": {
            "number": "YOUR OWN ICP NUMBER"
        }
    }
}

or you can add label to custom your label:

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

or you can add link to custom your link:

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

or you can add style to custom your style of number:

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

Note: Above snippet can be used as complete book.json file, if your book doesn't have one yet.

Author

👤 snowdreams1006

Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a Star if this project helped you!

Copyright

This project is MIT licensed.

Thanks

/zhj3618/gitbook-plugin-tbfed-pagefooter

Usage no npm install needed!