versions

README

gitbook-plugin-versions

Display a <select> with other versions of your gitbook.

Usage with gitbook.com

When your book is hosted on GitBook.com, the plugin can access a listing of versions using the GitBook API.

Put this in your book.json:

{
    "plugins": [ "versions" ],
    "pluginsConfig": {
        "versions": {
            "type": "branches"
        }
    }
}

Type can have different values:

  • Branches (branches)
  • Tags (tags)
  • Languages (languages)

Usage with a manual configuration

Put this in your book.json:

{
    "plugins": [ "versions" ],
    "pluginsConfig": {
        "versions": {
            "gitbookConfigURL": "https://raw.githubusercontent.com/rackt/history/gh-pages/book.json",
            "options": [
                {
                    "value": "https://rackt.github.io/history/v1.3.0/",
                    "text": "Version 1.3.0"
                },
                {
                    "value": "https://rackt.github.io/history/v1.4.0/",
                    "text": "Version 1.4.0",
                    "selected": true
                }
            ]
        }
    }
}

A <select> element will be created with the given options and placed at the top of the book summary. When the user selects one of the options, they are taken to that URL.

The gitbookConfigURL variable is a publicly accessible URL to your book.json. If this is present, the plugin will fetch the latest config when the page loads, so even older versions of your book will have updated options.

Credits

Original work by @mjackson.

Configuration

Setting Description Type Allowed values
includeFilepath Boolean
-
type String
default = branches
One of [branches,tags,languages]

Plugin

Display a <select> with other versions of your gitbook


Latest: 2.1.4

1.0.0, 1.1.0, 2.0.0-pre.1, 2.0.0, 2.0.1, 2.1.0, 2.1.1, 2.1.2, 2.1.3, 2.1.4,

Requirements

GitBook
2.0.0-pre.1 *
2.0.0 >=2.5.0
2.1.4 >=2.6.2

Maintainers

Open on NPM