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

Gitbook plugin that provide GitHub Buttons.
https://github.com/azu/gitbook-plugin-github-buttons

gitbook github plugin

Last synced: 3 months ago
JSON representation

Gitbook plugin that provide GitHub Buttons.

• Host: GitHub
• URL: https://github.com/azu/gitbook-plugin-github-buttons
• Owner: azu
• License: mit
• Created: 2015-09-21T13:20:47.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-11-11T03:01:14.000Z (about 8 years ago)
• Last Synced: 2025-03-31T03:15:13.349Z (10 months ago)
• Topics: gitbook, github, plugin
• Language: JavaScript
• Homepage:
• Size: 20.5 KB
• Stars: 15
• Watchers: 3
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# gitbook-plugin-github-buttons

Gitbook plugin that provide [The Unofficial GitHub Watch & Fork Buttons](https://ghbtns.com/ "The Unofficial GitHub Watch & Fork Buttons").

![screenshot](https://monosnap.com/file/pzLUbsaOvgah0aWPt6E0TqG0l73faX.png)

## Installation

    npm install gitbook-plugin-github-buttons

## Usage

Plugin Config

```json

{

  "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