56 lines
1.2 KiB
Markdown
56 lines
1.2 KiB
Markdown
|
# gitbook-plugin-github-buttons
|
||
|
|
|
||
|
|
Gitbook plugin that provide [The Unofficial GitHub Watch & Fork Buttons](https://ghbtns.com/ "The Unofficial GitHub Watch & Fork Buttons").
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
npm install gitbook-plugin-github-buttons
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Plugin Config
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"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:
|
||
|
|
|
||
|
|
```json
|
||
|
|
"size": "small"
|
||
|
|
"width": 90,
|
||
|
|
"height": 21
|
||
|
|
```
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
- [azu/JavaScript-Plugin-Architecture](https://github.com/azu/JavaScript-Plugin-Architecture "azu/JavaScript-Plugin-Architecture")
|
||
|
|
|
||
|
|
## 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
|