gitbook-plugin-githubcontributors
v0.2.1
Published
GitHub contributors for gitbook plugin
Downloads
11
Maintainers
Readme
This plugin insterts contributions from GitHub service via GitHub API.
If you have any questions, we can
Features
- adds contributors from GitHub via GitHub API (0.0.1)
- link to contributors page (0.1.0)
- background changes when theme changes (0.1.0)
- hardcoded link and sorting bugfixes (0.1.1)
- customisation for contributor
div
width. Default is 300px (0.2.0) - add margin between contributor elements (0.2.1)
Usage
Add plugin and it's configuration to your book.json
file:
"plugins": [
"githubcontributors"
],
"pluginsConfig": {
"githubcontributors": {
"githubOwner": "username", // GitHub user name e.g. sta-szek
"githubRepository": "repo-name" // GitHub repo name e.g. pojo-tester
}
}
Then you have to tell plugin, where you want the content to be inserted. To do this use gitbook block:
{% GitHubContributors %}
{% endGitHubContributors %}
Sample result
Feel free to contribute!
If you have any ideas just rise and issue or send PR! :beers: