Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 1.77 KB

README.md

File metadata and controls

59 lines (41 loc) · 1.77 KB

Fork Me GitBook Plugin

Display a ribbon linked to your GitHub repo in your gitbook.

NPM version License Downloads

Plugin Page

Image

Longer Page Width

ribbon with long width

Short Page Width

button with short width

Usage

Put this in your book.json:

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

Properties

  • url: Your github repository
  • color: Ribbon color (default: gray)
    • gray, darkblue, red, green, orange

Contributing

Hope your request!

Fork me on GitHub, and request your fix in this!