https://github.com/gitbookio/plugin-versions

Display a <select> with other versions of your gitbook
https://github.com/gitbookio/plugin-versions

Last synced: 5 months ago
JSON representation

Display a <select> with other versions of your gitbook

• Host: GitHub
• URL: https://github.com/gitbookio/plugin-versions
• Owner: GitbookIO
• Created: 2015-08-19T19:35:44.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-03-16T18:23:22.000Z (almost 9 years ago)
• Last Synced: 2025-04-25T23:34:14.197Z (9 months ago)
• Language: JavaScript
• Size: 15.6 KB
• Stars: 15
• Watchers: 2
• Forks: 6
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
## gitbook-plugin-versions

Display a `` with other versions of your gitbook.

### Usage with gitbook.com

When your book is hosted on [GitBook.com](https://www.gitbook.com), the plugin can access a listing of versions using the [GitBook API](http://developer.gitbook.com/books/versions/).

Put this in your book.json:

```js

{

    "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:

```js

{

    "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 `` 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](https://github.com/mjackson).