https://github.com/sandoche/gitbook-plugin-contributors-each-page

A gitbook plugin that adds the list of contributors for each page (works only with GitHub)
https://github.com/sandoche/gitbook-plugin-contributors-each-page

contributors gitbook gitbook-plugin github github-contributions

Last synced: 3 months ago
JSON representation

A gitbook plugin that adds the list of contributors for each page (works only with GitHub)

• Host: GitHub
• URL: https://github.com/sandoche/gitbook-plugin-contributors-each-page
• Owner: sandoche
• License: mit
• Created: 2019-03-09T17:09:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-06-24T22:26:27.000Z (over 3 years ago)
• Last Synced: 2025-07-11T20:41:56.772Z (3 months ago)
• Topics: contributors, gitbook, gitbook-plugin, github, github-contributions
• Language: JavaScript
• Homepage:
• Size: 51.8 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Gitbook-plugin-contributors-each-page

[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](/LICENSE)

[![Medium Badge](https://badgen.net/badge/icon/medium?icon=medium&label)](https://medium.com/@sandoche)

[![Twitter: sandochee](https://img.shields.io/twitter/follow/sandochee.svg?style=social)](https://twitter.com/sandochee)

A gitbook plugins that adds the list of contributors for each page (works only with GitHub)

## Example

![example](example.png)

## Installation

```

npm install gitbook-plugin-contributors-each-page --save-dev

```

Update book.json, do not forget to replace owner and repository with your Github owner and Github repository name:

```

{

  "plugins": [

    "contributors-each-page"

  ],

  "contributors-each-page": {

      "owner": "naming-convention",

      "repository": "naming-convention-guides",

      "title": "Contributors",

      "excluded": ["README.md"]

    }

  }

}

```

Excluded contains the array of filepath of file where you don't want to add the contributors.

To overcome the problem with the Github API, add a .env file on the root of your gitbook project, go there to create one: https://github.com/settings/tokens

```

GH_TOKEN=your_github_token

```

## ⭐️ Show your support

Please ⭐️ this repository if this project helped you!

[![patreon.png](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/sandoche)

## 🍺 Buy me a beer 

If you like this project, feel free to donate:

* PayPal: https://www.paypal.me/kanbanote

* Bitcoin: 19JiNZ1LkMaz57tewqJaTg2hQWH4RgW4Yp

* Ethereum: 0xded81fa4624e05339924355fe3504ba9587d5419

* Monero: 43jqzMquW2q989UKSrB2YbeffhmJhbYb2Yxu289bv7pLRh4xVgMKj5yTd52iL6x1dvCYs9ERg5biHYxMjGkpSTs6S2jMyJn

* Motive: MOTIV-25T5-SD65-V7LJ-BBWRD (Get Motive Now: https://motive.network)