├── .eslintrc
├── .gitignore
├── README.md
├── assets
    ├── plugin.css
    └── plugin.js
├── index.js
└── package.json


/.eslintrc:
--------------------------------------------------------------------------------
 1 | {
 2 |     "rules": {
 3 |         "indent": [ 2, 4 ],
 4 |         "quotes": [ 2, "single" ],
 5 |         "linebreak-style": [ 2, "unix" ],
 6 |         "semi": [ 2, "always" ],
 7 |         "no-unused-vars": [ 2, {
 8 |             "vars": "all",
 9 |             "args": "none"
10 |         } ],
11 |         "spaced-comment": [ 2, "always" ]
12 |     },
13 |     "env": {
14 |         "node": true,
15 |         "mocha": true,
16 |         "browser": true
17 |     },
18 |     "extends": "eslint:recommended"
19 | }


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules/


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | ## gitbook-plugin-versions
 2 | 
 3 | Display a `<select>` with other versions of your gitbook.
 4 | 
 5 | ### Usage with gitbook.com
 6 | 
 7 | 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/).
 8 | 
 9 | Put this in your book.json:
10 | 
11 | ```js
12 | {
13 |     "plugins": [ "versions" ],
14 |     "pluginsConfig": {
15 |         "versions": {
16 |             "type": "branches"
17 |         }
18 |     }
19 | }
20 | ```
21 | 
22 | Type can have different values:
23 | 
24 | - Branches (`branches`)
25 | - Tags (`tags`)
26 | - Languages (`languages`)
27 | 
28 | ### Usage with a manual configuration
29 | 
30 | Put this in your book.json:
31 | 
32 | ```js
33 | {
34 |     "plugins": [ "versions" ],
35 |     "pluginsConfig": {
36 |         "versions": {
37 |             "gitbookConfigURL": "https://raw.githubusercontent.com/rackt/history/gh-pages/book.json",
38 |             "options": [
39 |                 {
40 |                     "value": "https://rackt.github.io/history/v1.3.0/",
41 |                     "text": "Version 1.3.0"
42 |                 },
43 |                 {
44 |                     "value": "https://rackt.github.io/history/v1.4.0/",
45 |                     "text": "Version 1.4.0",
46 |                     "selected": true
47 |                 }
48 |             ]
49 |         }
50 |     }
51 | }
52 | ```
53 | 
54 | 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.
55 | 
56 | 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`.
57 | 
58 | ### Credits
59 | 
60 | Original work by [@mjackson](https://github.com/mjackson).
61 | 


--------------------------------------------------------------------------------
/assets/plugin.css:
--------------------------------------------------------------------------------
 1 | .versions-select {
 2 |     display: table;
 3 |     width: 100%;
 4 |     height: 50px;
 5 |     padding: 0px 12px;
 6 | }
 7 | 
 8 | .versions-select > div {
 9 |     display: table-cell;
10 |     text-align: center;
11 |     vertical-align: middle;
12 | }
13 | 
14 | .versions-select select {
15 |     width: 100%;
16 | }
17 | 


--------------------------------------------------------------------------------
/assets/plugin.js:
--------------------------------------------------------------------------------
 1 | require(['gitbook', 'jQuery'], function (gitbook, $) {
 2 |     var versions = [],
 3 |         current  = undefined,
 4 |         pluginConfig = {};
 5 | 
 6 |     // Update the select with a list of versions
 7 |     function updateVersions(_versions) {
 8 |         versions = _versions || versions;
 9 |         current  = $('.versions-select select').val() || current;
10 | 
11 |         // Cleanup existing selector
12 |         $('.versions-select').remove();
13 | 
14 |         if (versions.length == 0) return;
15 | 
16 |         var $li = $('<li>', {
17 |             'class': 'versions-select',
18 |             'html': '<div><select></select></div>'
19 |         });
20 |         var $select = $li.find('select');
21 | 
22 |         $.each(versions, function(i, version) {
23 |             var $option = $('<option>', {
24 |                 'selected': (current === undefined ? version.selected : (current === version.value)),
25 |                 'value': version.value,
26 |                 'text': version.text
27 |             });
28 | 
29 |             $option.appendTo($select);
30 |         });
31 | 
32 |         $select.change(function() {
33 |             var filtered = $.grep(versions, function(v) {
34 |                 return v.value === $select.val();
35 |             });
36 |             // Get actual version Object from array
37 |             var version = filtered[0];
38 | 
39 |             var filePath = location.href.replace(gitbook.state.bookRoot, '');
40 |             window.location.href = version.includeFilepath? (version.value + filePath) : version.value;
41 |         });
42 | 
43 |         $li.prependTo('.book-summary ul.summary');
44 |     }
45 | 
46 |     // Fetch version from book.json (legacy plugin)
47 |     function fetchBookOptionsVersions(gitbookConfigURL) {
48 |         $.getJSON(gitbookConfigURL, function (bookConfig) {
49 |             var options = bookConfig.pluginsConfig.versions.options;
50 |             updateVersions(options);
51 |         });
52 |     }
53 | 
54 |     // Fetch gitbook.com versions
55 |     function fetchBookVersions(type) {
56 |         $.getJSON(gitbook.state.bookRoot+'gitbook/api/versions/'+type, function (versions) {
57 |             updateVersions($.map(versions, function(v) {
58 |                 return {
59 |                     text: v.name,
60 |                     value: v.urls.website,
61 |                     selected: v.current,
62 |                     includeFilepath: pluginConfig.includeFilepath !== false && type !== 'languages'
63 |                 };
64 |             }));
65 |         });
66 |     }
67 | 
68 |     gitbook.events.bind('start', function (e, config) {
69 |         pluginConfig = config.versions || {};
70 |         if (pluginConfig.options) updateVersions(pluginConfig.options);
71 | 
72 |         // Make sure we have a current book.json
73 |         if (pluginConfig.gitbookConfigURL)  fetchBookOptionsVersions(pluginConfig.gitbookConfigURL);
74 |         else fetchBookVersions(pluginConfig.type || 'branches');
75 |     });
76 | 
77 |     gitbook.events.bind('page.change', function () {
78 |         updateVersions();
79 |     });
80 | });
81 | 


--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
 1 | module.exports = {
 2 |     website: {
 3 |         assets: './assets',
 4 |         js: [
 5 |             'plugin.js'
 6 |         ],
 7 |         css: [
 8 |             'plugin.css'
 9 |         ]
10 |     }
11 | };
12 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "gitbook-plugin-versions",
 3 |   "version": "2.1.4",
 4 |   "description": "Display a <select> with other versions of your gitbook",
 5 |   "main": "index.js",
 6 |   "author": "Samy Pesse <samypesse@gmail.com>",
 7 |   "license": "Apache-2.0",
 8 |   "engines": {
 9 |     "gitbook": ">=2.6.2"
10 |   },
11 |   "gitbook": {
12 |     "properties": {
13 |       "type": {
14 |         "type": "string",
15 |         "enum": [
16 |           "branches",
17 |           "tags",
18 |           "languages"
19 |         ],
20 |         "default": "branches"
21 |       },
22 |       "includeFilepath": {
23 |         "type": "boolean",
24 |         "description": "True to insert current filepath at the end of the version url"
25 |       }
26 |     }
27 |   },
28 |   "devDependencies": {
29 |     "eslint": "^2.7.0"
30 |   }
31 | }
32 | 


--------------------------------------------------------------------------------