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
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.6%) to scientific vocabulary
Keywords
Repository
Gitbook plugin, which adds GitHub contributors content in declared block via GitHub API.
Basic Info
Statistics
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
This plugin insterts contributions from GitHub service via GitHub API.
If you have any questions, we can chat on 
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
divwidth. 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
Feel free to contribute!
If you have any ideas just rise and issue or send PR! :beers:
Owner
- Name: Piotr Joński
- Login: sta-szek
- Kind: user
- Website: pojo.pl
- Repositories: 38
- Profile: https://github.com/sta-szek
GitHub Events
Total
Last Year
Committers
Last synced: almost 3 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Piotr Joński | y****o@w****u | 27 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 4
- Total pull requests: 7
- Average time to close issues: 5 days
- Average time to close pull requests: 1 minute
- Total issue authors: 2
- Total pull request authors: 1
- Average comments per issue: 1.75
- Average comments per pull request: 0.0
- Merged pull requests: 7
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- sta-szek (3)
- amcdnl (1)
Pull Request Authors
- sta-szek (7)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- npm 3 last-month
- Total dependent packages: 1
- Total dependent repositories: 3
- Total versions: 5
- Total maintainers: 1
npmjs.org: gitbook-plugin-githubcontributors
GitHub contributors for gitbook plugin
- Homepage: https://github.com/sta-szek/gitbook-plugin-githubcontributors#readme
- License: GPL-3.0
-
Latest release: 0.2.1
published about 9 years ago