update docs

dnoneill · May 15, 2019 · f49182b · f49182b
1 parent 7cc8f4c
commit f49182b
Show file tree

Hide file tree

Showing 35 changed files with 44 additions and 13,944 deletions.
diff --git a/docs/404.html b/docs/404.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/assets/js/just-the-docs.js b/docs/assets/js/just-the-docs.js
@@ -153,7 +153,6 @@ function initSearch() {
 function pageFocus() {
   var mainContent = document.querySelector('.js-main-content');
   mainContent.focus();
-  console.log(mainContent)
 }
 
 

diff --git a/docs/assets/js/search-data.json b/docs/assets/js/search-data.json
diff --git a/docs/demo.html b/docs/demo.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/dist/advanced-search.css b/docs/dist/advanced-search.css
diff --git a/docs/dist/advanced-search.js b/docs/dist/advanced-search.js
diff --git a/docs/dist/custom-search.js b/docs/dist/custom-search.js
diff --git a/docs/docs/quickstart/frontend.html b/docs/docs/quickstart/frontend.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/docs/quickstart/installation.html b/docs/docs/quickstart/installation.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/docs/quickstart/searchform.html b/docs/docs/quickstart/searchform.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/docs/quickstart/setup.html b/docs/docs/quickstart/setup.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">
@@ -183,6 +183,8 @@
   <li><a href="#display-fields" id="markdown-toc-display-fields">Display fields</a></li>
   <li><a href="#atozsortfield" id="markdown-toc-atozsortfield">atozsortfield</a></li>
   <li><a href="#fuzzysearchfields" id="markdown-toc-fuzzysearchfields">fuzzysearchfields</a></li>
+  <li><a href="#view_facets" id="markdown-toc-view_facets">view_facets</a></li>
+  <li><a href="#js_dir" id="markdown-toc-js_dir">js_dir</a></li>
   <li><a href="#full-settings-example" id="markdown-toc-full-settings-example">Full settings example</a></li>
 </ul>
 
@@ -349,6 +351,16 @@ <h2 id="fuzzysearchfields">fuzzysearchfields</h2>
   fuzzysearchfields: [name]
 </code></pre></div></div>
 
+<h2 id="view_facets">view_facets</h2>
+<p><strong>view_facets</strong> should be a number field. This is an <strong>optional</strong> field, if it is not set it will revert to the <strong>default</strong> setting of 4. This determines how many facets are shown, if there are more facets then view_facets the remaining facets will be hidden but can be displayed with the “Show All” button that is automatically generated.</p>
+
+<h2 id="js_dir">js_dir</h2>
+<p>You can choose to store <code class="highlighter-rouge">index.js</code>, <code class="highlighter-rouge">custom-search.js</code> and <code class="highlighter-rouge">lunr.js</code> in a different directory like this:</p>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lunr_settings:
+  js_dir: "javascript"
+</code></pre></div></div>
+
 <h2 id="full-settings-example">Full settings example</h2>
 <p>An example of all these settings can be seen below. An example of it running is here: <a href="https://dnoneill.github.io/jekyll-customsearch/search?q=&amp;name=&amp;ethnicity=">https://dnoneill.github.io/jekyll-customsearch/search?q=&amp;name=&amp;ethnicity=</a></p>
 
@@ -402,6 +414,7 @@ <h2 id="full-settings-example">Full settings example</h2>
     secondaryfield: contributorId
     widget: relational
   fuzzysearchfields: [name, birthplace, residences, worklocations]
+  view_facets: 5
 </code></pre></div></div>
 
 

diff --git a/docs/explore.html b/docs/explore.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/feed.xml b/docs/feed.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.8.5">Jekyll</generator><link href="/jekyll-lunr-js-custom-search/feed.xml" rel="self" type="application/atom+xml" /><link href="/jekyll-lunr-js-custom-search/" rel="alternate" type="text/html" /><updated>2019-03-27T17:55:05-04:00</updated><id>/jekyll-lunr-js-custom-search/feed.xml</id><title type="html">jekyll-lunr-js-custom-search</title><subtitle>Documentation and demo for jekyll-lunr-js-custom-search</subtitle></feed>
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.8.5">Jekyll</generator><link href="/jekyll-lunr-js-custom-search/feed.xml" rel="self" type="application/atom+xml" /><link href="/jekyll-lunr-js-custom-search/" rel="alternate" type="text/html" /><updated>2019-05-15T13:28:58-04:00</updated><id>/jekyll-lunr-js-custom-search/feed.xml</id><title type="html">jekyll-lunr-js-custom-search</title><subtitle>Documentation and demo for jekyll-lunr-js-custom-search</subtitle></feed>
diff --git a/docs/index.html b/docs/index.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/js/advanced-search.js b/docs/js/advanced-search.js
diff --git a/docs/js/custom-search.js b/docs/js/custom-search.js
diff --git a/docs/js/index.js b/docs/js/index.js
diff --git a/docs/people/P000001.html b/docs/people/P000001.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/people/P000002.html b/docs/people/P000002.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/people/P000003.html b/docs/people/P000003.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/people/P000004.html b/docs/people/P000004.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/people/P000005.html b/docs/people/P000005.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/people/P000006.html b/docs/people/P000006.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/people/P000007.html b/docs/people/P000007.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/people/P000008.html b/docs/people/P000008.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/people/P000009.html b/docs/people/P000009.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/people/P000010.html b/docs/people/P000010.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/people/P000011.html b/docs/people/P000011.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/people/P000012.html b/docs/people/P000012.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/quickstart.html b/docs/quickstart.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/works/W00001.html b/docs/works/W00001.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/works/W00002.html b/docs/works/W00002.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/works/W00003.html b/docs/works/W00003.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/works/W00004.html b/docs/works/W00004.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">

diff --git a/docs/works/W00005.html b/docs/works/W00005.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en-us">
+<html lang="en-US">
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.8.5">Jekyll</generator><link href="/jekyll-lunr-js-custom-search/feed.xml" rel="self" type="application/atom+xml" /><link href="/jekyll-lunr-js-custom-search/" rel="alternate" type="text/html" /><updated>2019-03-27T17:55:05-04:00</updated><id>/jekyll-lunr-js-custom-search/feed.xml</id><title type="html">jekyll-lunr-js-custom-search</title><subtitle>Documentation and demo for jekyll-lunr-js-custom-search</subtitle></feed>
		<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.8.5">Jekyll</generator><link href="/jekyll-lunr-js-custom-search/feed.xml" rel="self" type="application/atom+xml" /><link href="/jekyll-lunr-js-custom-search/" rel="alternate" type="text/html" /><updated>2019-05-15T13:28:58-04:00</updated><id>/jekyll-lunr-js-custom-search/feed.xml</id><title type="html">jekyll-lunr-js-custom-search</title><subtitle>Documentation and demo for jekyll-lunr-js-custom-search</subtitle></feed>