contributors-each-page

README

Gitbook-plugin-contributors-each-page

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

Example

example

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

Configuration

Setting Description Type Allowed values
excluded Array
-
owner String
-
repository String
-
title String
-

Plugin

A gitbook plugins that adds the list of contributors for each page 👥

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


Latest: 1.0.1

1.0.0, 1.0.1,

Requirements

GitBook
1.0.1 >1.x.x

Maintainers

Open on NPM