lunr-elastic-search
Version:
Uses Lunr.js to index and search the knowledge base.
100 lines (65 loc) • 6.67 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home | lunr-elastic-search</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/tui-doc.css">
</head>
<body>
<nav class="lnb" id="lnb">
<div class="logo" style="">
<img src="img/toast-ui.png" width="100%" height="100%">
</div>
<div class="title">
<h1><a href="index.html" class="link">lunr-elastic-search</a></h1>
</div>
<div class="search-container" id="search-container">
<input type="text" placeholder="Search">
<ul></ul>
</div>
<div class="lnb-api hidden"><h3>Classes</h3><ul><li><a href="LunrSearch.html">LunrSearch</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="LunrSearch_sub"><div class="member-type">Members</div><ul class="inner"><li><a href="LunrSearch.html#.VERSION">VERSION</a></li><li><a href="LunrSearch.html#builder">builder</a></li><li><a href="LunrSearch.html#docs">docs</a></li><li><a href="LunrSearch.html#domain">domain</a></li><li><a href="LunrSearch.html#editDistance">editDistance</a></li><li><a href="LunrSearch.html#index">index</a></li><li><a href="LunrSearch.html#pass">pass</a></li><li><a href="LunrSearch.html#plugins">plugins</a></li><li><a href="LunrSearch.html#user">user</a></li></ul><div class="member-type">Methods</div><ul class="inner"><li><a href="LunrSearch.html#.buildIndex">buildIndex</a></li><li><a href="LunrSearch.html#.exportIndex">exportIndex</a></li><li><a href="LunrSearch.html#.fetch">fetch</a></li><li><a href="LunrSearch.html#.getIndex">getIndex</a></li><li><a href="LunrSearch.html#.importIndex">importIndex</a></li><li><a href="LunrSearch.html#.isSupported">isSupported</a></li><li><a href="LunrSearch.html#.postIndex">postIndex</a></li><li><a href="LunrSearch.html#.search">search</a></li><li><a href="LunrSearch.html#buildIndex">buildIndex</a></li><li><a href="LunrSearch.html#exportIndex">exportIndex</a></li><li><a href="LunrSearch.html#fetch">fetch</a></li><li><a href="LunrSearch.html#getIndex">getIndex</a></li><li><a href="LunrSearch.html#importIndex">importIndex</a></li><li><a href="LunrSearch.html#postIndex">postIndex</a></li><li><a href="LunrSearch.html#search">search</a></li></ul><div class="member-type">Typedef</div><ul class="inner"><li><a href="LunrSearch.html#.Plugin">Plugin</a></li><li><a href="LunrSearch.html#.Result">Result</a></li></ul></div></li></ul></div><div class="lnb-api hidden"><h3>Namespaces</h3><ul><li><a href="plugin.html">plugin</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="plugin_sub"></div></li><li><a href="plugin.freshdesk.html">plugin.freshdesk</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="plugin.freshdesk_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="plugin.freshdesk.html#.fetch">fetch</a></li><li><a href="plugin.freshdesk.html#.isSupported">isSupported</a></li><li><a href="plugin.freshdesk.html#.plugin">plugin</a></li><li><a href="plugin.freshdesk.html#.process">process</a></li></ul></div></li><li><a href="util.html">util</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="util_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="util.html#.definedFunction">definedFunction</a></li></ul></div></li></ul></div>
</nav>
<div id="resizer"></div>
<div class="main" id="main">
<section>
<article class="readme"><h1>elastic-search</h1><p><a href="https://gitlab.com/sightreadingfactory-open-source/elastic-search/commits/master"><img src="https://gitlab.com/sightreadingfactory-open-source/elastic-search/badges/master/pipeline.svg" alt="pipeline status"></a>
<a href="https://www.npmjs.com/package/lunr-elastic-search"><img src="https://img.shields.io/npm/v/lunr-elastic-search.svg" alt="npm"></a>
<a href="https://gitlab.com/sightreadingfactory-open-source/elastic-search/LICENSE"><img src="https://img.shields.io/npm/l/lunr-elastic-search.svg" alt="npm"></a></p>
<h2>Documentation</h2><p>API documentation is available at https://sightreadingfactory-open-source.gitlab.io/elastic-search/docs.</p>
<h2>Reports</h2><ul>
<li>Unit tests: https://sightreadingfactory-open-source.gitlab.io/elastic-search/reports/unit</li>
<li>Coverage: https://sightreadingfactory-open-source.gitlab.io/elastic-search/reports/coverage</li>
</ul>
<h2>Installation</h2><p>For usage in the browser:</p>
<p>Latest version:</p>
<pre class="prettyprint source lang-html"><code><script src="https://unpkg.com/lunr-elastic-search"></script></code></pre><p>Specific version #.#.#:</p>
<pre class="prettyprint source lang-html"><code><script src="https://unpkg.com/lunr-elastic-search@#.#.#"></script></code></pre><p>This will create a global variable <code>LunrSearch</code> which is the class <a href="https://sightreadingfactory-open-source.gitlab.io/elastic-search/docs/LunrSearch.html"><code>LunrSearch</code></a></p>
<h2>Usage</h2><p>Refer to the <a href="https://sightreadingfactory-open-source.gitlab.io/elastic-search/docs/LunrSearch.html">API docs</a></p></article>
</section>
</div>
<footer>
<img class="logo" src="img/toast-ui.png" style="">
<div class="footer-text">made this awesome JSDoc theme!</div>
</footer>
<script>prettyPrint();</script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/tui-doc.js"></script>
<script src="scripts/linenumber.js"></script>
<script>
var id = 'package:undefined_sub'.replace(/"/g, '_');
var selectedApi = document.getElementById(id); // do not use jquery selector
var $selectedApi = $(selectedApi);
$selectedApi.removeClass('hidden');
$selectedApi.parent().find('.glyphicon').removeClass('glyphicon-plus').addClass('glyphicon-minus');
showLnbApi();
</script>
</body>
</html>