gitbook-plugin-github-buttons

Gitbook plugin that provide The Unofficial GitHub Watch & Fork Buttons.

screenshot

Installation

  1. npm install gitbook-plugin-github-buttons

Usage

Plugin Config

  1. {
  2.   "plugins": [
  3.     "github-buttons"
  4.   ],
  5.   "pluginsConfig": {
  6.     "github-buttons": {
  7.       "repo": "azu/JavaScript-Plugin-Architecture",
  8.       "types": [
  9.         "star",
  10.         "watch"
  11.       ],
  12.       "size": "large"
  13.     }
  14.   }
  15. }

The default size of large is 150 x 30, and small is 100 x 20, however, you can specify the size you want by using width and height. Such as:

  1.       "size": "small"
  2.       "width": 90,
  3.       "height": 21

Example

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT