github-buttons

README

gitbook-plugin-github-buttons

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

screenshot

Installation

npm install gitbook-plugin-github-buttons

Usage

Plugin Config

{
  "plugins": [
    "github-buttons"
  ],
  "pluginsConfig": {
    "github-buttons": {
      "repo": "azu/JavaScript-Plugin-Architecture",
      "types": [
        "star",
        "watch"
      ],
      "size": "large"
    }
  }
}

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:

      "size": "small"
      "width": 90,
      "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

Plugin

Gitbook plugin provide GitHub Button.

https://github.com/azu/gitbook-plugin-github-buttons


Latest: 2.1.0

1.0.1, 1.0.2, 1.0.3, 1.0.4, 1.1.0, 1.1.1, 1.1.2, 1.2.0, 1.2.1, 1.2.2, 1.2.3, 2.0.0, 2.0.1, 2.1.0,

Requirements

GitBook
1.0.2 >2.x.x
2.1.0 *

Maintainers

Open on NPM