azu / gitbook-plugin-github-buttons

Gitbook plugin that provide GitHub Buttons.

gitbook-plugin-github-buttons

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

Installation

npm install gitbook-plugin-github-buttons

Usage

Plugin Config

{
  "plugins": [
    "github-buttons"
  ],
  "pluginsConfig": {
    "github-buttons": {
      "buttons": [{
        "user": "azu",
        "repo": "JavaScript-Plugin-Architecture",
        "type": "star",
        "size": "large"
      }, {
        "user": "azu",
        "type": "follow",
        "width": "230",
        "count": false
      }]
    }
  }
}

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" || "large"
• "width": number
• "height": number

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

gitbook-plugin-github-buttons's Issues

Add user following support.

I want to add a user following button laying beside project starring button. As https://ghbtns.com/ also supports user following button, I think it could be implemented. Would you like to add this functionality to your plugin?

version 3.0.0 button not show

I use V2.1.0 the button will show. However the newest V3.0.0 will not.
CLI version: 2.3.2
GitBook version: 3.2.3

config as:

"github-buttons": {
            "user": "user id",
            "repo": "XXXX",
            "types": [
                "star",
                "fork"
            ],
            "size": "small"
        }

it does not work for gitbook 3.1.1

https://www.npmjs.com/package/gitbook 3.1.1

GitBook Community in Google+

Hi azu,

I am Aleen (https://github.com/aleen42) , and the founder of GitBook Community in Google+: https://plus.google.com/communities/110696788983472771007, which aims to sharing books or plugins of GitBook, talking anything about it as well. Here I am sincerely inviting you to join us. 👊

Bug: github-buttons is not responsive, take half space of mobile screen.

It's not ideal to use github-buttons on mobile device, the buttons make the screen half blank:

Maybe should consider hide on mobile.

Too much space between buttons

There is too much space between github buttons. It should be configurable or auto-resizable.

This is how it looks like:

Overmore, styles could change, after switching to other css: