gitbook-edit is a Gitbook plugin for providing a button on the toolbar for readers to edit their github projects.

Installation

add the following plugins to your book.json and run gitbook install

{
    "plugins": ["github-edit"]
}

Usage

just find plugin on gitbook and install it on your gitbook project.

configuration option can be set as an obj like, and of course you can use a default value shown as followed:

{
    "plugins": [
        "github-edit"
    ],
    "pluginsConfig": {
        "github-edit": {
            "repo": "aleen42/PersonalWiki",
            "branch": "master"
        }
    }
}

Release History

• ==================== 1.0.4 Initial release ====================
  • 1.0.5 update readme
  • 1.0.6 update readme
  • 1.0.8 consider the case of using a root property
  • 1.0.9 fix the problem of getting wrong file path
  • 1.1.0 extend url option for configuring
  • 1.1.1 remove unused dependencies

:fuelpump: How to contribute

Have an idea? Found a bug? See how to contribute.

:scroll: License

MIT © aleen42