mirror of
https://github.com/danbulant/api_docs
synced 2026-05-27 13:52:12 +00:00
Fixes toc alignment on search and adds highlight library
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
This commit is contained in:
parent
59ee05c606
commit
5892700b5c
4 changed files with 167 additions and 32 deletions
|
|
@ -1,5 +1,6 @@
|
||||||
(function (global) {
|
(function (global) {
|
||||||
|
|
||||||
|
var $global = $(global);
|
||||||
var index = lunr(function () {
|
var index = lunr(function () {
|
||||||
this.ref('id');
|
this.ref('id');
|
||||||
this.field('title', { boost: 10 });
|
this.field('title', { boost: 10 });
|
||||||
|
|
@ -29,17 +30,26 @@
|
||||||
}
|
}
|
||||||
|
|
||||||
function bind () {
|
function bind () {
|
||||||
$('#input-search').on('keyup', function () {
|
$('#input-search').on('keyup', search);
|
||||||
|
}
|
||||||
|
|
||||||
|
function search () {
|
||||||
|
var sections = $('section, #toc .tocify-header');
|
||||||
|
|
||||||
if (this.value) {
|
if (this.value) {
|
||||||
var items = index.search(this.value);
|
var items = index.search(this.value);
|
||||||
$('section, #toc .tocify-item').hide();
|
sections.hide();
|
||||||
items.forEach(function (item) {
|
items.forEach(function (item) {
|
||||||
$('#section-' + item.ref + ', .tocify-item[data-unique=' + item.ref).show();
|
$('#section-' + item.ref).show();
|
||||||
|
$('.tocify-item[data-unique=' + item.ref + ']').closest('.tocify-header').show();
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
$('section, #toc .tocify-item').show();
|
sections.show();
|
||||||
}
|
}
|
||||||
});
|
|
||||||
|
// HACK trigger tocify height recalculation
|
||||||
|
$global.triggerHandler('scroll.tocify');
|
||||||
|
$global.triggerHandler('resize');
|
||||||
}
|
}
|
||||||
|
|
||||||
})(window);
|
})(window);
|
||||||
|
|
|
||||||
|
|
@ -1,24 +1,37 @@
|
||||||
$(function() {
|
(function (global) {
|
||||||
var toc = $("#toc").tocify({
|
|
||||||
selectors: "h1,h2",
|
var toc;
|
||||||
|
|
||||||
|
global.toc = toc;
|
||||||
|
|
||||||
|
$(toc);
|
||||||
|
$(animate);
|
||||||
|
|
||||||
|
function toc () {
|
||||||
|
toc = $("#toc").tocify({
|
||||||
|
selectors: 'h1, h2',
|
||||||
extendPage: false,
|
extendPage: false,
|
||||||
theme: "none",
|
theme: 'none',
|
||||||
smoothScroll: false,
|
smoothScroll: false,
|
||||||
showEffectSpeed: 0,
|
showEffectSpeed: 0,
|
||||||
hideEffectSpeed: 180,
|
hideEffectSpeed: 180,
|
||||||
ignoreSelector: ".toc-ignore",
|
ignoreSelector: '.toc-ignore',
|
||||||
hashGenerator: 'pretty',
|
|
||||||
highlightOffset: 60,
|
highlightOffset: 60,
|
||||||
scrollTo: -2,
|
scrollTo: -2,
|
||||||
scrollHistory: true,
|
scrollHistory: true,
|
||||||
hashGenerator: function (text, element) {
|
hashGenerator: function (text, element) {
|
||||||
return element[0].getAttribute('id');
|
return element.prop('id');
|
||||||
|
}
|
||||||
|
}).data('toc-tocify');
|
||||||
}
|
}
|
||||||
}).data("toc-tocify");
|
|
||||||
|
|
||||||
// Hack to make already open sections to start opened,
|
// Hack to make already open sections to start opened,
|
||||||
// instead of displaying an ugly animation
|
// instead of displaying an ugly animation
|
||||||
|
function animate () {
|
||||||
setTimeout(function() {
|
setTimeout(function() {
|
||||||
toc.setOption("showEffectSpeed", 180);
|
toc.setOption('showEffectSpeed', 180);
|
||||||
}, 50);
|
}, 50);
|
||||||
});
|
}
|
||||||
|
|
||||||
|
})(window);
|
||||||
|
|
||||||
|
|
|
||||||
108
source/javascripts/lib/jquery.highlight.js
Normal file
108
source/javascripts/lib/jquery.highlight.js
Normal file
|
|
@ -0,0 +1,108 @@
|
||||||
|
/*
|
||||||
|
* jQuery Highlight plugin
|
||||||
|
*
|
||||||
|
* Based on highlight v3 by Johann Burkard
|
||||||
|
* http://johannburkard.de/blog/programming/javascript/highlight-javascript-text-higlighting-jquery-plugin.html
|
||||||
|
*
|
||||||
|
* Code a little bit refactored and cleaned (in my humble opinion).
|
||||||
|
* Most important changes:
|
||||||
|
* - has an option to highlight only entire words (wordsOnly - false by default),
|
||||||
|
* - has an option to be case sensitive (caseSensitive - false by default)
|
||||||
|
* - highlight element tag and class names can be specified in options
|
||||||
|
*
|
||||||
|
* Usage:
|
||||||
|
* // wrap every occurrance of text 'lorem' in content
|
||||||
|
* // with <span class='highlight'> (default options)
|
||||||
|
* $('#content').highlight('lorem');
|
||||||
|
*
|
||||||
|
* // search for and highlight more terms at once
|
||||||
|
* // so you can save some time on traversing DOM
|
||||||
|
* $('#content').highlight(['lorem', 'ipsum']);
|
||||||
|
* $('#content').highlight('lorem ipsum');
|
||||||
|
*
|
||||||
|
* // search only for entire word 'lorem'
|
||||||
|
* $('#content').highlight('lorem', { wordsOnly: true });
|
||||||
|
*
|
||||||
|
* // don't ignore case during search of term 'lorem'
|
||||||
|
* $('#content').highlight('lorem', { caseSensitive: true });
|
||||||
|
*
|
||||||
|
* // wrap every occurrance of term 'ipsum' in content
|
||||||
|
* // with <em class='important'>
|
||||||
|
* $('#content').highlight('ipsum', { element: 'em', className: 'important' });
|
||||||
|
*
|
||||||
|
* // remove default highlight
|
||||||
|
* $('#content').unhighlight();
|
||||||
|
*
|
||||||
|
* // remove custom highlight
|
||||||
|
* $('#content').unhighlight({ element: 'em', className: 'important' });
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* Copyright (c) 2009 Bartek Szopka
|
||||||
|
*
|
||||||
|
* Licensed under MIT license.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
jQuery.extend({
|
||||||
|
highlight: function (node, re, nodeName, className) {
|
||||||
|
if (node.nodeType === 3) {
|
||||||
|
var match = node.data.match(re);
|
||||||
|
if (match) {
|
||||||
|
var highlight = document.createElement(nodeName || 'span');
|
||||||
|
highlight.className = className || 'highlight';
|
||||||
|
var wordNode = node.splitText(match.index);
|
||||||
|
wordNode.splitText(match[0].length);
|
||||||
|
var wordClone = wordNode.cloneNode(true);
|
||||||
|
highlight.appendChild(wordClone);
|
||||||
|
wordNode.parentNode.replaceChild(highlight, wordNode);
|
||||||
|
return 1; //skip added node in parent
|
||||||
|
}
|
||||||
|
} else if ((node.nodeType === 1 && node.childNodes) && // only element nodes that have children
|
||||||
|
!/(script|style)/i.test(node.tagName) && // ignore script and style nodes
|
||||||
|
!(node.tagName === nodeName.toUpperCase() && node.className === className)) { // skip if already highlighted
|
||||||
|
for (var i = 0; i < node.childNodes.length; i++) {
|
||||||
|
i += jQuery.highlight(node.childNodes[i], re, nodeName, className);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
jQuery.fn.unhighlight = function (options) {
|
||||||
|
var settings = { className: 'highlight', element: 'span' };
|
||||||
|
jQuery.extend(settings, options);
|
||||||
|
|
||||||
|
return this.find(settings.element + "." + settings.className).each(function () {
|
||||||
|
var parent = this.parentNode;
|
||||||
|
parent.replaceChild(this.firstChild, this);
|
||||||
|
parent.normalize();
|
||||||
|
}).end();
|
||||||
|
};
|
||||||
|
|
||||||
|
jQuery.fn.highlight = function (words, options) {
|
||||||
|
var settings = { className: 'highlight', element: 'span', caseSensitive: false, wordsOnly: false };
|
||||||
|
jQuery.extend(settings, options);
|
||||||
|
|
||||||
|
if (words.constructor === String) {
|
||||||
|
words = [words];
|
||||||
|
}
|
||||||
|
words = jQuery.grep(words, function(word, i){
|
||||||
|
return word != '';
|
||||||
|
});
|
||||||
|
words = jQuery.map(words, function(word, i) {
|
||||||
|
return word.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
|
||||||
|
});
|
||||||
|
if (words.length == 0) { return this; };
|
||||||
|
|
||||||
|
var flag = settings.caseSensitive ? "" : "i";
|
||||||
|
var pattern = "(" + words.join("|") + ")";
|
||||||
|
if (settings.wordsOnly) {
|
||||||
|
pattern = "\\b" + pattern + "\\b";
|
||||||
|
}
|
||||||
|
var re = new RegExp(pattern, flag);
|
||||||
|
|
||||||
|
return this.each(function () {
|
||||||
|
jQuery.highlight(this, re, settings.element, settings.className);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
|
@ -35,6 +35,10 @@ html, body {
|
||||||
background-color: $main-bg;
|
background-color: $main-bg;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.highlight {
|
||||||
|
background-color: #FFFF88;
|
||||||
|
}
|
||||||
|
|
||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
// TABLE OF CONTENTS
|
// TABLE OF CONTENTS
|
||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue