gitbook-plugin-versions-select
v0.1.1
Published
Fork of versions plugin with selected status based on url.
Downloads
86
Readme
gitbook-plugin-versions-select
This is a modified version of Versions
Display a <select>
with other versions of your gitbook that you have specified in your book.json
file.
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-select" ],
"pluginsConfig": {
"versions": {
"gitbookConfigURL": "https://raw.githubusercontent.com/prescottprue/react-redux-firebase/v2.0.0/book.json",
"options": [
{
"value": "http://react-redux-firebase.com/history/v1.4.0/",
"text": "Version v1.4.0"
},
{
"value": "http://react-redux-firebase.com/history/v1.4.0/",
"text": "Version v2.0.0"
}
]
}
}
}
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
.
FAQ
- How is this different than
gitbook-plugin-versions
The active version selected in the <select>
is based location.
- How is this different than
gitbook-plugin-feathers-versions
?
Versions on the same domain under different folders are supported
Credits
Original work by @mjackson.
License
Apache 2