elixir-toolkit-theme 1.5.0

data/assets/js/search.js

@@ -0,0 +1,404 @@
+---
+layout: none
+permalink: assets/js/search.js
+---
+/**
+ * Search based on just the docs
+ * 
+ * https://github.com/pmarsceill/just-the-docs
+ * The MIT License (MIT)
+ * Copyright (c) 2016 Patrick Marsceill
+ */
+
+(function (Website, undefined) {
+
+    // Event handling
+
+    Website.addEvent = function (el, type, handler) {
+        if (el.attachEvent) el.attachEvent('on' + type, handler); else el.addEventListener(type, handler);
+    }
+    Website.removeEvent = function (el, type, handler) {
+        if (el.detachEvent) el.detachEvent('on' + type, handler); else el.removeEventListener(type, handler);
+    }
+    Website.onReady = function (ready) {
+        // in case the document is already rendered
+        if (document.readyState != 'loading') ready();
+        // modern browsers
+        else if (document.addEventListener) document.addEventListener('DOMContentLoaded', ready);
+        // IE <= 8
+        else document.attachEvent('onreadystatechange', function () {
+            if (document.readyState == 'complete') ready();
+        });
+    }
+
+    function initSearch() {
+        var request = new XMLHttpRequest();
+        request.open('GET', "{{ 'assets/js/search-data.json' | relative_url }}", true);
+
+        request.onload = function () {
+            if (request.status >= 200 && request.status < 400) {
+                var docs = JSON.parse(request.responseText);
+
+                lunr.tokenizer.separator = /[\s/]+/
+
+                var index = lunr(function () {
+                    this.ref('id');
+                    this.field('title', { boost: 200 });
+                    this.field('content', { boost: 2 });
+                    this.field('relUrl');
+                    this.metadataWhitelist = ['position']
+
+                    for (var i in docs) {
+                        this.add({
+                            id: i,
+                            title: docs[i].title,
+                            content: docs[i].content,
+                            relUrl: docs[i].relUrl
+                        });
+                    }
+                });
+
+                searchLoaded(index, docs);
+            } else {
+                console.log('Error loading ajax request. Request status:' + request.status);
+            }
+        };
+
+        request.onerror = function () {
+            console.log('There was a connection error');
+        };
+
+        request.send();
+    }
+
+    function searchLoaded(index, docs) {
+        var index = index;
+        var docs = docs;
+        var searchInput = document.getElementById('search-input');
+        var searchResults = document.getElementById('search-results');
+        var currentInput;
+        var currentSearchIndex = 0;
+
+        function showSearch() {
+            document.documentElement.classList.add('search-active');
+        }
+
+        function hideSearch() {
+            document.documentElement.classList.remove('search-active');
+        }
+
+        function update() {
+            currentSearchIndex++;
+
+            var input = searchInput.value;
+            if (input === '') {
+                hideSearch();
+            } else {
+                showSearch();
+                // scroll search input into view, workaround for iOS Safari
+                window.scroll(0, -1);
+                setTimeout(function () { window.scroll(0, 0); }, 0);
+            }
+            if (input === currentInput) {
+                return;
+            }
+            currentInput = input;
+            searchResults.innerHTML = '';
+            if (input === '') {
+                return;
+            }
+
+            var results = index.query(function (query) {
+                var tokens = lunr.tokenizer(input)
+                query.term(tokens, {
+                    boost: 10
+                });
+                query.term(tokens, {
+                    wildcard: lunr.Query.wildcard.TRAILING
+                });
+            });
+
+            if ((results.length == 0) && (input.length > 2)) {
+                var tokens = lunr.tokenizer(input).filter(function (token, i) {
+                    return token.str.length < 20;
+                })
+                if (tokens.length > 0) {
+                    results = index.query(function (query) {
+                        query.term(tokens, {
+                            editDistance: Math.round(Math.sqrt(input.length / 2 - 1))
+                        });
+                    });
+                }
+            }
+
+            if (results.length == 0) {
+                var noResultsDiv = document.createElement('div');
+                noResultsDiv.classList.add('search-no-result');
+                noResultsDiv.innerText = 'No results found';
+                searchResults.appendChild(noResultsDiv);
+
+            } else {
+                var resultsList = document.createElement('ul');
+                searchResults.appendChild(resultsList);
+
+                addResults(resultsList, results, 0, 10, 100, currentSearchIndex);
+            }
+
+            function addResults(resultsList, results, start, batchSize, batchMillis, searchIndex) {
+                if (searchIndex != currentSearchIndex) {
+                    return;
+                }
+                for (var i = start; i < (start + batchSize); i++) {
+                    if (i == results.length) {
+                        return;
+                    }
+                    addResult(resultsList, results[i]);
+                }
+                setTimeout(function () {
+                    addResults(resultsList, results, start + batchSize, batchSize, batchMillis, searchIndex);
+                }, batchMillis);
+            }
+
+            function addResult(resultsList, result) {
+                var doc = docs[result.ref];
+
+                var resultsListItem = document.createElement('li');
+                resultsList.appendChild(resultsListItem);
+
+                var resultLink = document.createElement('a');
+                resultLink.setAttribute('href', doc.url);
+                resultsListItem.appendChild(resultLink);
+
+                var resultTitle = document.createElement('div');
+                resultTitle.classList.add('search-result-title');
+                resultLink.appendChild(resultTitle);
+
+                var resultDoc = document.createElement('div');
+                resultDoc.classList.add('search-result-doc');
+                resultTitle.appendChild(resultDoc);
+
+                var resultDocTitle = document.createElement('div');
+                resultDocTitle.classList.add('search-result-doc-title');
+                resultDocTitle.innerHTML = doc.doc;
+                resultDoc.appendChild(resultDocTitle);
+                var resultDocOrSection = resultDocTitle;
+
+                if (doc.doc != doc.title) {
+                    resultDoc.classList.add('search-result-doc-parent');
+                    var resultSection = document.createElement('div');
+                    resultSection.classList.add('search-result-section');
+                    resultSection.innerHTML = doc.title;
+                    resultTitle.appendChild(resultSection);
+                    resultDocOrSection = resultSection;
+                }
+
+                var metadata = result.matchData.metadata;
+                var titlePositions = [];
+                var contentPositions = [];
+                for (var j in metadata) {
+                    var meta = metadata[j];
+                    if (meta.title) {
+                        var positions = meta.title.position;
+                        for (var k in positions) {
+                            titlePositions.push(positions[k]);
+                        }
+                    }
+                    if (meta.content) {
+                        var positions = meta.content.position;
+                        for (var k in positions) {
+                            var position = positions[k];
+                            var previewStart = position[0];
+                            var previewEnd = position[0] + position[1];
+                            var ellipsesBefore = true;
+                            var ellipsesAfter = true;
+                            for (var k = 0; k < 4; k++) {
+                                var nextSpace = doc.content.lastIndexOf(' ', previewStart - 2);
+                                var nextDot = doc.content.lastIndexOf('. ', previewStart - 2);
+                                if ((nextDot >= 0) && (nextDot > nextSpace)) {
+                                    previewStart = nextDot + 1;
+                                    ellipsesBefore = false;
+                                    break;
+                                }
+                                if (nextSpace < 0) {
+                                    previewStart = 0;
+                                    ellipsesBefore = false;
+                                    break;
+                                }
+                                previewStart = nextSpace + 1;
+                            }
+                            for (var k = 0; k < 4; k++) {
+                                var nextSpace = doc.content.indexOf(' ', previewEnd + 1);
+                                var nextDot = doc.content.indexOf('. ', previewEnd + 1);
+                                if ((nextDot >= 0) && (nextDot < nextSpace)) {
+                                    previewEnd = nextDot;
+                                    ellipsesAfter = false;
+                                    break;
+                                }
+                                if (nextSpace < 0) {
+                                    previewEnd = doc.content.length;
+                                    ellipsesAfter = false;
+                                    break;
+                                }
+                                previewEnd = nextSpace;
+                            }
+                            contentPositions.push({
+                                highlight: position,
+                                previewStart: previewStart, previewEnd: previewEnd,
+                                ellipsesBefore: ellipsesBefore, ellipsesAfter: ellipsesAfter
+                            });
+                        }
+                    }
+                }
+
+                if (titlePositions.length > 0) {
+                    titlePositions.sort(function (p1, p2) { return p1[0] - p2[0] });
+                    resultDocOrSection.innerHTML = '';
+                    addHighlightedText(resultDocOrSection, doc.title, 0, doc.title.length, titlePositions);
+                }
+
+                if (contentPositions.length > 0) {
+                    contentPositions.sort(function (p1, p2) { return p1.highlight[0] - p2.highlight[0] });
+                    var contentPosition = contentPositions[0];
+                    var previewPosition = {
+                        highlight: [contentPosition.highlight],
+                        previewStart: contentPosition.previewStart, previewEnd: contentPosition.previewEnd,
+                        ellipsesBefore: contentPosition.ellipsesBefore, ellipsesAfter: contentPosition.ellipsesAfter
+                    };
+                    var previewPositions = [previewPosition];
+                    for (var j = 1; j < contentPositions.length; j++) {
+                        contentPosition = contentPositions[j];
+                        if (previewPosition.previewEnd < contentPosition.previewStart) {
+                            previewPosition = {
+                                highlight: [contentPosition.highlight],
+                                previewStart: contentPosition.previewStart, previewEnd: contentPosition.previewEnd,
+                                ellipsesBefore: contentPosition.ellipsesBefore, ellipsesAfter: contentPosition.ellipsesAfter
+                            }
+                            previewPositions.push(previewPosition);
+                        } else {
+                            previewPosition.highlight.push(contentPosition.highlight);
+                            previewPosition.previewEnd = contentPosition.previewEnd;
+                            previewPosition.ellipsesAfter = contentPosition.ellipsesAfter;
+                        }
+                    }
+
+                    var resultPreviews = document.createElement('div');
+                    resultPreviews.classList.add('search-result-previews');
+                    resultLink.appendChild(resultPreviews);
+
+                    var content = doc.content;
+                    for (var j = 0; j < Math.min(previewPositions.length, 3); j++) {
+                        var position = previewPositions[j];
+
+                        var resultPreview = document.createElement('div');
+                        resultPreview.classList.add('search-result-preview');
+                        resultPreviews.appendChild(resultPreview);
+
+                        if (position.ellipsesBefore) {
+                            resultPreview.appendChild(document.createTextNode('... '));
+                        }
+                        addHighlightedText(resultPreview, content, position.previewStart, position.previewEnd, position.highlight);
+                        if (position.ellipsesAfter) {
+                            resultPreview.appendChild(document.createTextNode(' ...'));
+                        }
+                    }
+                }
+                //  Show relative url in search results 
+                //  var resultRelUrl = document.createElement('span');
+                //  resultRelUrl.classList.add('search-result-rel-url');
+                //  resultRelUrl.innerText = doc.relUrl;
+                //  resultTitle.appendChild(resultRelUrl);
+            }
+
+            function addHighlightedText(parent, text, start, end, positions) {
+                var index = start;
+                for (var i in positions) {
+                    var position = positions[i];
+                    var span = document.createElement('span');
+                    span.innerHTML = text.substring(index, position[0]);
+                    parent.appendChild(span);
+                    index = position[0] + position[1];
+                    var highlight = document.createElement('span');
+                    highlight.classList.add('search-result-highlight');
+                    highlight.innerHTML = text.substring(position[0], index);
+                    parent.appendChild(highlight);
+                }
+                var span = document.createElement('span');
+                span.innerHTML = text.substring(index, end);
+                parent.appendChild(span);
+            }
+        }
+
+        Website.addEvent(searchInput, 'focus', function () {
+            setTimeout(update, 0);
+        });
+
+        Website.addEvent(searchInput, 'keyup', function (e) {
+            switch (e.keyCode) {
+                case 27: // When esc key is pressed, hide the results and clear the field
+                    searchInput.value = '';
+                    break;
+                case 38: // arrow up
+                case 40: // arrow down
+                case 13: // enter
+                    e.preventDefault();
+                    return;
+            }
+            update();
+        });
+
+        Website.addEvent(searchInput, 'keydown', function (e) {
+            switch (e.keyCode) {
+                case 38: // arrow up
+                    e.preventDefault();
+                    var active = document.querySelector('.search-results a.active');
+                    if (active) {
+                        active.classList.remove('active');
+                        if (active.parentElement.previousSibling) {
+                            var previous = active.parentElement.previousSibling.querySelector('.search-results a');
+                            previous.classList.add('active');
+                        }
+                    }
+                    return;
+                case 40: // arrow down
+                    e.preventDefault();
+                    var active = document.querySelector('.search-results a.active');
+                    if (active) {
+                        if (active.parentElement.nextSibling) {
+                            var next = active.parentElement.nextSibling.querySelector('.search-results a');
+                            active.classList.remove('active');
+                            next.classList.add('active');
+                        }
+                    } else {
+                        var next = document.querySelector('.search-results a');
+                        if (next) {
+                            next.classList.add('active');
+                        }
+                    }
+                    return;
+                case 13: // enter
+                    e.preventDefault();
+                    var active = document.querySelector('.search-results a.active');
+                    if (active) {
+                        active.click();
+                    } else {
+                        var first = document.querySelector('.search-results');
+                        if (first) {
+                            first.click();
+                        }
+                    }
+                    return;
+            }
+        });
+
+        Website.addEvent(document, 'click', function (e) {
+            if (e.target != searchInput) {
+                hideSearch();
+            }
+        });
+    }
+
+    Website.onReady(function () {
+        initSearch();
+    });
+
+})(window.Website = window.Website || {});

data/assets/js/toc.js

@@ -0,0 +1,99 @@
+// https://github.com/ghiculescu/jekyll-table-of-contents
+(function($){
+  $.fn.toc = function(options) {
+    var defaults = {
+      noBackToTopLinks: false,
+      title: '<i>Jump to...</i>',
+      minimumHeaders: 3,
+      headers: 'h1, h2, h3, h4, h5, h6',
+      listType: 'ol', // values: [ol|ul]
+      showEffect: 'show', // values: [show|slideDown|fadeIn|none]
+      showSpeed: 'slow', // set to 0 to deactivate effect
+      classes: { list: '',
+                 item: '',
+                 link: ''
+               }
+    },
+    settings = $.extend(defaults, options);
+
+    function fixedEncodeURIComponent (str) {
+      return encodeURIComponent(str).replace(/[!'()*]/g, function(c) {
+        return '%' + c.charCodeAt(0).toString(16);
+      });
+    }
+
+    function createLink (header) {
+      var innerText = (header.textContent === undefined) ? header.innerText : header.textContent;
+      return "<a class='"+settings.classes.link+"' href='#" + fixedEncodeURIComponent(header.id) + "'>" + innerText + "</a>";
+    }
+
+    var headers = $(settings.headers).filter(function() {
+      // get all headers with an ID
+      var previousSiblingName = $(this).prev().attr( "name" );
+      if (!this.id && previousSiblingName) {
+        this.id = $(this).attr( "id", previousSiblingName.replace(/\./g, "-") );
+      }
+      return this.id;
+    }), output = $(this);
+    if (!headers.length || headers.length < settings.minimumHeaders || !output.length) {
+      $(this).hide();
+      return;
+    }
+
+    if (0 === settings.showSpeed) {
+      settings.showEffect = 'none';
+    }
+
+    var render = {
+      show: function() { output.hide().html(html).show(settings.showSpeed); },
+      slideDown: function() { output.hide().html(html).slideDown(settings.showSpeed); },
+      fadeIn: function() { output.hide().html(html).fadeIn(settings.showSpeed); },
+      none: function() { output.html(html); }
+    };
+
+    var get_level = function(ele) { return parseInt(ele.nodeName.replace("H", ""), 10); };
+    var highest_level = headers.map(function(_, ele) { return get_level(ele); }).get().sort()[0];
+    var return_to_top = '<i class="icon-arrow-up back-to-top"> </i>';
+
+    var level = get_level(headers[0]),
+      this_level,
+      html = settings.title + " <" +settings.listType + " class=\"" + settings.classes.list +"\">";
+    headers.on('click', function() {
+      if (!settings.noBackToTopLinks) {
+        window.location.hash = this.id;
+      }
+    })
+    .addClass('clickable-header')
+    .each(function(_, header) {
+      this_level = get_level(header);
+      if (!settings.noBackToTopLinks && this_level === highest_level) {
+        $(header).addClass('top-level-header').after(return_to_top);
+      }
+      if (this_level === level) // same level as before; same indenting
+        html += "<li class=\"" + settings.classes.item + "\">" + createLink(header);
+      else if (this_level <= level){ // higher level than before; end parent ol
+        for(var i = this_level; i < level; i++) {
+          html += "</li></"+settings.listType+">"
+        }
+        html += "<li class=\"" + settings.classes.item + "\">" + createLink(header);
+      }
+      else if (this_level > level) { // lower level than before; expand the previous to contain a ol
+        for(i = this_level; i > level; i--) {
+          html += "<" + settings.listType + " class=\"" + settings.classes.list +"\">" +
+                  "<li class=\"" + settings.classes.item + "\">"
+        }
+        html += createLink(header);
+      }
+      level = this_level; // update for the next one
+    });
+    html += "</"+settings.listType+">";
+    if (!settings.noBackToTopLinks) {
+      $(document).on('click', '.back-to-top', function() {
+        $(window).scrollTop(0);
+        window.location.hash = '';
+      });
+    }
+
+    render[settings.showEffect]();
+  };
+})(jQuery);