github

README

plugin-github

Display a link to your GitHub repo in your gitbook.

Usage

Put this in your book.json:

{
    "plugins": [ "github" ],
    "pluginsConfig": {
        "github": {
            "url": "https://github.com/your/repo"
        }
    }
}

And you're done!

Credits

Original work by @mjackson.

Configuration

Setting Description Type Allowed values
url
required
URL to your GitHub repository String
-

Plugin

Display a link to your GitHub repo in your gitbook

https://github.com/GitbookIO/plugin-github#readme


Latest: 2.0.0

1.0.0, 1.0.2, 1.1.0, 2.0.0,

Requirements

GitBook
1.1.0 *
2.0.0 >=2.5.0

Maintainers

Open on NPM