adding search

Author: vsoch

docs/README.md

@@ -3,6 +3,7 @@ layout: default
 title: {{ site.name }}
 pdf: true
 permalink: /
+excluded_in_search: true
 ---
 
 <div style="float:right; margin-bottom:50px; color:#666">
@@ -16,7 +17,6 @@ permalink: /
 # Singularity Python
 Welcome to the Singularity Python documentation!
 
-
 ## What is Singularity Python
 Singularity Python is a Python API to work with the <a href="https://singularityware.github.io" target="_blank">Singularity</a> open source software. Are you a scientist or developer? You likely will be most interested in the ability to interact with Singularity containers from your own Python scripts. See <a href="https://singularityhub.github.io/singularity-cli/api/source/spython.main.html" target="_blank">here</a> for the core module docstrings.
 

docs/_includes/page-header.html

@@ -1,3 +1,3 @@
 <section class="page-header">
-  <a href="{{ site.baseurl }}/"><h2 class="project-name">{{ site.title }}</h2></a>
+  <a href="{{ site.baseurl }}/"><span class="project-name">{{ site.title }}</span> <span style="float:right">                {% include search.html %}</span></a>
 </section>

docs/_includes/search.html

@@ -0,0 +1,5 @@
+<form action="{{ site.baseurl }}/search" method="get">
+	<input type="search" name="q" id="search-input" placeholder="What would you like to know?" style="margin-top:5px" autofocus>
+	<i style="color:white; margin-right:8px; margin-left:5px" class="fa fa-search"></i>
+	<input type="submit" value="Search" style="display: none;">
+</form>

docs/js/lunr.min.js

@@ -0,0 +1,103 @@
+---
+layout: null
+---
+(function () {
+	function getQueryVariable(variable) {
+		var query = window.location.search.substring(1),
+			vars = query.split("&");
+
+		for (var i = 0; i < vars.length; i++) {
+			var pair = vars[i].split("=");
+
+			if (pair[0] === variable) {
+				return decodeURIComponent(pair[1].replace(/\+/g, '%20')).trim();
+			}
+		}
+	}
+
+	function getPreview(query, content, previewLength) {
+		previewLength = previewLength || (content.length * 2);
+
+		var parts = query.split(" "),
+			match = content.toLowerCase().indexOf(query.toLowerCase()),
+			matchLength = query.length,
+			preview;
+
+		// Find a relevant location in content
+		for (var i = 0; i < parts.length; i++) {
+			if (match >= 0) {
+				break;
+			}
+
+			match = content.toLowerCase().indexOf(parts[i].toLowerCase());
+			matchLength = parts[i].length;
+		}
+
+		// Create preview
+		if (match >= 0) {
+			var start = match - (previewLength / 2),
+				end = start > 0 ? match + matchLength + (previewLength / 2) : previewLength;
+
+			preview = content.substring(start, end).trim();
+
+			if (start > 0) {
+				preview = "..." + preview;
+			}
+
+			if (end < content.length) {
+				preview = preview + "...";
+			}
+
+			// Highlight query parts
+			preview = preview.replace(new RegExp("(" + parts.join("|") + ")", "gi"), "<strong>$1</strong>");
+		} else {
+			// Use start of content if no match found
+			preview = content.substring(0, previewLength).trim() + (content.length > previewLength ? "..." : "");
+		}
+
+		return preview;
+	}
+
+	function displaySearchResults(results, query) {
+		var searchResultsEl = document.getElementById("search-results"),
+			searchProcessEl = document.getElementById("search-process");
+
+		if (results.length) {
+			var resultsHTML = "";
+			results.forEach(function (result) {
+				var item = window.data[result.ref],
+					contentPreview = getPreview(query, item.content, 170),
+					titlePreview = getPreview(query, item.title);
+
+				resultsHTML += "<li><h4><a href='{{ site.baseurl }}" + item.url.trim() + "'>" + titlePreview + "</a></h4><p><small>" + contentPreview + "</small></p></li>";
+			});
+
+			searchResultsEl.innerHTML = resultsHTML;
+			searchProcessEl.innerText = "Showing";
+		} else {
+			searchResultsEl.style.display = "none";
+			searchProcessEl.innerText = "No";
+		}
+	}
+
+	window.index = lunr(function () {
+		this.field("id");
+		this.field("title", {boost: 10});
+		this.field("categories");
+		this.field("url");
+		this.field("content");
+	});
+
+	var query = decodeURIComponent((getQueryVariable("q") || "").replace(/\+/g, "%20")),
+		searchQueryContainerEl = document.getElementById("search-query-container"),
+		searchQueryEl = document.getElementById("search-query");
+
+	searchQueryEl.innerText = query;
+	searchQueryContainerEl.style.display = "inline";
+
+	for (var key in window.data) {
+		window.index.add(window.data[key]);
+	}
+
+	displaySearchResults(window.index.search(query), query); // Hand the results off to be displayed
+})();