https://github.com/sta-szek/gitbook-plugin-githubcontributors

Gitbook plugin, which adds GitHub contributors content in declared block via GitHub API.
https://github.com/sta-szek/gitbook-plugin-githubcontributors

contributions contributors gitbook gitbook-plugin github plugin

Last synced: about 2 months ago
JSON representation

Gitbook plugin, which adds GitHub contributors content in declared block via GitHub API.

• Host: GitHub
• URL: https://github.com/sta-szek/gitbook-plugin-githubcontributors
• Owner: sta-szek
• License: gpl-3.0
• Created: 2016-10-31T17:28:59.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-12-14T18:53:54.000Z (over 9 years ago)
• Last Synced: 2025-10-11T18:13:18.737Z (6 months ago)
• Topics: contributions, contributors, gitbook, gitbook-plugin, github, plugin
• Language: JavaScript
• Homepage:
• Size: 142 KB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
This plugin insterts contributions from GitHub service via GitHub API.





If you have any questions, we can chat on [![Rocket.Chat](https://demo.rocket.chat/images/join-chat.svg)](http://chat.pojo.pl/channel/gitbook-plugins)

# 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

    "contributorWidth": "300px"     // Width of contributor divs. Default is 300px. Margin between divs is 10px.

  }

}

```

Then you have to tell plugin, where you want the content to be inserted.

To do this use gitbook block:

```

{% GitHubContributors %}

{% endGitHubContributors %}

```

# Sample result

![](examples/example.png)

# Feel free to contribute!

If you have any ideas just rise and issue or send PR! :beers: