README.md

gitbook-plugin-octocat

Display a link to your GitHub repository in your GitBook/HonKit.

Installation

Install via npm:

npm install gitbook-plugin-octocat --save-dev

Usage

Put this in your book.json:

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

And you're done!

Credits

• Original work by @mjackson.
• Edited for GitLab support by Chathu Vishwajith.
• Modified to support GitHub by Duck McSouls.