Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history 
fix repo link in docs

fix links in README
  • Loading branch information
@lucaong
lucaong committed Apr 25, 2020
1 parent 3c93541 commit 187f5e6
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Expand Up @@ -315,7 +315,7 @@ be used to provide those functions.
## Contributing

Contributions to `MiniSearch` are welcome! Please read the [contributions
guidelines](https://github.com/lucaong/minisearch/CONTRIBUTING.html).
guidelines](https://github.com/lucaong/minisearch/CONTRIBUTING.md).
Reading the [design
document](https://github.com/lucaong/minisearch/DESIGN_DOCUMENT.html) is
document](https://github.com/lucaong/minisearch/DESIGN_DOCUMENT.md) is
also useful to understand the project goals and the technical implementation.
8 changes: 4 additions & 4 deletions docs/MiniSearch.html
View file
Expand Up @@ -29,7 +29,7 @@

<input type="text" id="nav-search" placeholder="Search" />

<h2><a href="index.html">Home</a></h2><h2><a href="https://gitlab.com/lucaong/minisearch" target="_blank" class="menu-item" id="github_repo_link" >GitHub Repository</a></h2><h3>Classes</h3><ul><li><a href="MiniSearch.html">MiniSearch</a><ul class='methods'><li data-type='method'><a href="MiniSearch.html#.getDefault">getDefault</a></li><li data-type='method'><a href="MiniSearch.html#.loadJSON">loadJSON</a></li><li data-type='method'><a href="MiniSearch.html#add">add</a></li><li data-type='method'><a href="MiniSearch.html#addAll">addAll</a></li><li data-type='method'><a href="MiniSearch.html#addAllAsync">addAllAsync</a></li><li data-type='method'><a href="MiniSearch.html#autoSuggest">autoSuggest</a></li><li data-type='method'><a href="MiniSearch.html#remove">remove</a></li><li data-type='method'><a href="MiniSearch.html#search">search</a></li><li data-type='method'><a href="MiniSearch.html#toJSON">toJSON</a></li></ul></li><li><a href="SearchableMap.html">SearchableMap</a><ul class='methods'><li data-type='method'><a href="SearchableMap.html#.from">from</a></li><li data-type='method'><a href="SearchableMap.html#.fromObject">fromObject</a></li><li data-type='method'><a href="SearchableMap.html#atPrefix">atPrefix</a></li><li data-type='method'><a href="SearchableMap.html#clear">clear</a></li><li data-type='method'><a href="SearchableMap.html#delete">delete</a></li><li data-type='method'><a href="SearchableMap.html#entries">entries</a></li><li data-type='method'><a href="SearchableMap.html#forEach">forEach</a></li><li data-type='method'><a href="SearchableMap.html#fuzzyGet">fuzzyGet</a></li><li data-type='method'><a href="SearchableMap.html#get">get</a></li><li data-type='method'><a href="SearchableMap.html#has">has</a></li><li data-type='method'><a href="SearchableMap.html#keys">keys</a></li><li data-type='method'><a href="SearchableMap.html#set">set</a></li><li data-type='method'><a href="SearchableMap.html#update">update</a></li><li data-type='method'><a href="SearchableMap.html#values">values</a></li></ul></li></ul>
<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/lucaong/minisearch" target="_blank" class="menu-item" id="github_repo_link" >GitHub Repository</a></h2><h3>Classes</h3><ul><li><a href="MiniSearch.html">MiniSearch</a><ul class='methods'><li data-type='method'><a href="MiniSearch.html#.getDefault">getDefault</a></li><li data-type='method'><a href="MiniSearch.html#.loadJSON">loadJSON</a></li><li data-type='method'><a href="MiniSearch.html#add">add</a></li><li data-type='method'><a href="MiniSearch.html#addAll">addAll</a></li><li data-type='method'><a href="MiniSearch.html#addAllAsync">addAllAsync</a></li><li data-type='method'><a href="MiniSearch.html#autoSuggest">autoSuggest</a></li><li data-type='method'><a href="MiniSearch.html#remove">remove</a></li><li data-type='method'><a href="MiniSearch.html#search">search</a></li><li data-type='method'><a href="MiniSearch.html#toJSON">toJSON</a></li></ul></li><li><a href="SearchableMap.html">SearchableMap</a><ul class='methods'><li data-type='method'><a href="SearchableMap.html#.from">from</a></li><li data-type='method'><a href="SearchableMap.html#.fromObject">fromObject</a></li><li data-type='method'><a href="SearchableMap.html#atPrefix">atPrefix</a></li><li data-type='method'><a href="SearchableMap.html#clear">clear</a></li><li data-type='method'><a href="SearchableMap.html#delete">delete</a></li><li data-type='method'><a href="SearchableMap.html#entries">entries</a></li><li data-type='method'><a href="SearchableMap.html#forEach">forEach</a></li><li data-type='method'><a href="SearchableMap.html#fuzzyGet">fuzzyGet</a></li><li data-type='method'><a href="SearchableMap.html#get">get</a></li><li data-type='method'><a href="SearchableMap.html#has">has</a></li><li data-type='method'><a href="SearchableMap.html#keys">keys</a></li><li data-type='method'><a href="SearchableMap.html#set">set</a></li><li data-type='method'><a href="SearchableMap.html#update">update</a></li><li data-type='method'><a href="SearchableMap.html#values">values</a></li></ul></li></ul>
</nav>

<div id="main">
Expand Down Expand Up @@ -634,7 +634,7 @@ <h3 class="subsection-title">Methods</h3>



<h4 class="name" id=".getDefault"><span class="type-signature">(static) </span>getDefault<span class="signature">(optionName)</span><span class="type-signature"> &rarr; {*}</span></h4>
<h4 class="name" id=".getDefault"><span class="type-signature">(static) </span>getDefault<span class="signature">(optionName)</span><span class="type-signature"> &rarr; {any}</span></h4>



Expand Down Expand Up @@ -791,7 +791,7 @@ <h5>Returns:</h5>
</dt>
<dd>

<span class="param-type">*</span>
<span class="param-type">any</span>


</dd>
Expand Down Expand Up @@ -3684,7 +3684,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 13:58:36 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 14:19:48 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
6 changes: 3 additions & 3 deletions docs/MiniSearch.js.html
View file
Expand Up @@ -29,7 +29,7 @@

<input type="text" id="nav-search" placeholder="Search" />

<h2><a href="index.html">Home</a></h2><h2><a href="https://gitlab.com/lucaong/minisearch" target="_blank" class="menu-item" id="github_repo_link" >GitHub Repository</a></h2><h3>Classes</h3><ul><li><a href="MiniSearch.html">MiniSearch</a><ul class='methods'><li data-type='method'><a href="MiniSearch.html#.getDefault">getDefault</a></li><li data-type='method'><a href="MiniSearch.html#.loadJSON">loadJSON</a></li><li data-type='method'><a href="MiniSearch.html#add">add</a></li><li data-type='method'><a href="MiniSearch.html#addAll">addAll</a></li><li data-type='method'><a href="MiniSearch.html#addAllAsync">addAllAsync</a></li><li data-type='method'><a href="MiniSearch.html#autoSuggest">autoSuggest</a></li><li data-type='method'><a href="MiniSearch.html#remove">remove</a></li><li data-type='method'><a href="MiniSearch.html#search">search</a></li><li data-type='method'><a href="MiniSearch.html#toJSON">toJSON</a></li></ul></li><li><a href="SearchableMap.html">SearchableMap</a><ul class='methods'><li data-type='method'><a href="SearchableMap.html#.from">from</a></li><li data-type='method'><a href="SearchableMap.html#.fromObject">fromObject</a></li><li data-type='method'><a href="SearchableMap.html#atPrefix">atPrefix</a></li><li data-type='method'><a href="SearchableMap.html#clear">clear</a></li><li data-type='method'><a href="SearchableMap.html#delete">delete</a></li><li data-type='method'><a href="SearchableMap.html#entries">entries</a></li><li data-type='method'><a href="SearchableMap.html#forEach">forEach</a></li><li data-type='method'><a href="SearchableMap.html#fuzzyGet">fuzzyGet</a></li><li data-type='method'><a href="SearchableMap.html#get">get</a></li><li data-type='method'><a href="SearchableMap.html#has">has</a></li><li data-type='method'><a href="SearchableMap.html#keys">keys</a></li><li data-type='method'><a href="SearchableMap.html#set">set</a></li><li data-type='method'><a href="SearchableMap.html#update">update</a></li><li data-type='method'><a href="SearchableMap.html#values">values</a></li></ul></li></ul>
<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/lucaong/minisearch" target="_blank" class="menu-item" id="github_repo_link" >GitHub Repository</a></h2><h3>Classes</h3><ul><li><a href="MiniSearch.html">MiniSearch</a><ul class='methods'><li data-type='method'><a href="MiniSearch.html#.getDefault">getDefault</a></li><li data-type='method'><a href="MiniSearch.html#.loadJSON">loadJSON</a></li><li data-type='method'><a href="MiniSearch.html#add">add</a></li><li data-type='method'><a href="MiniSearch.html#addAll">addAll</a></li><li data-type='method'><a href="MiniSearch.html#addAllAsync">addAllAsync</a></li><li data-type='method'><a href="MiniSearch.html#autoSuggest">autoSuggest</a></li><li data-type='method'><a href="MiniSearch.html#remove">remove</a></li><li data-type='method'><a href="MiniSearch.html#search">search</a></li><li data-type='method'><a href="MiniSearch.html#toJSON">toJSON</a></li></ul></li><li><a href="SearchableMap.html">SearchableMap</a><ul class='methods'><li data-type='method'><a href="SearchableMap.html#.from">from</a></li><li data-type='method'><a href="SearchableMap.html#.fromObject">fromObject</a></li><li data-type='method'><a href="SearchableMap.html#atPrefix">atPrefix</a></li><li data-type='method'><a href="SearchableMap.html#clear">clear</a></li><li data-type='method'><a href="SearchableMap.html#delete">delete</a></li><li data-type='method'><a href="SearchableMap.html#entries">entries</a></li><li data-type='method'><a href="SearchableMap.html#forEach">forEach</a></li><li data-type='method'><a href="SearchableMap.html#fuzzyGet">fuzzyGet</a></li><li data-type='method'><a href="SearchableMap.html#get">get</a></li><li data-type='method'><a href="SearchableMap.html#has">has</a></li><li data-type='method'><a href="SearchableMap.html#keys">keys</a></li><li data-type='method'><a href="SearchableMap.html#set">set</a></li><li data-type='method'><a href="SearchableMap.html#update">update</a></li><li data-type='method'><a href="SearchableMap.html#values">values</a></li></ul></li></ul>
</nav>

<div id="main">
Expand Down Expand Up @@ -537,7 +537,7 @@ <h1 class="page-title">MiniSearch.js</h1>
* the given name exists.
*
* @param {string} optionName - name of the option
* @return {*} the default value of the given option
* @return {any} the default value of the given option
*
* @example
* // Get default tokenizer
Expand Down Expand Up @@ -853,7 +853,7 @@ <h1 class="page-title">MiniSearch.js</h1>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 13:58:36 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 14:19:48 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
4 changes: 2 additions & 2 deletions docs/SearchableMap.html
View file
Expand Up @@ -29,7 +29,7 @@

<input type="text" id="nav-search" placeholder="Search" />

<h2><a href="index.html">Home</a></h2><h2><a href="https://gitlab.com/lucaong/minisearch" target="_blank" class="menu-item" id="github_repo_link" >GitHub Repository</a></h2><h3>Classes</h3><ul><li><a href="MiniSearch.html">MiniSearch</a><ul class='methods'><li data-type='method'><a href="MiniSearch.html#.getDefault">getDefault</a></li><li data-type='method'><a href="MiniSearch.html#.loadJSON">loadJSON</a></li><li data-type='method'><a href="MiniSearch.html#add">add</a></li><li data-type='method'><a href="MiniSearch.html#addAll">addAll</a></li><li data-type='method'><a href="MiniSearch.html#addAllAsync">addAllAsync</a></li><li data-type='method'><a href="MiniSearch.html#autoSuggest">autoSuggest</a></li><li data-type='method'><a href="MiniSearch.html#remove">remove</a></li><li data-type='method'><a href="MiniSearch.html#search">search</a></li><li data-type='method'><a href="MiniSearch.html#toJSON">toJSON</a></li></ul></li><li><a href="SearchableMap.html">SearchableMap</a><ul class='methods'><li data-type='method'><a href="SearchableMap.html#.from">from</a></li><li data-type='method'><a href="SearchableMap.html#.fromObject">fromObject</a></li><li data-type='method'><a href="SearchableMap.html#atPrefix">atPrefix</a></li><li data-type='method'><a href="SearchableMap.html#clear">clear</a></li><li data-type='method'><a href="SearchableMap.html#delete">delete</a></li><li data-type='method'><a href="SearchableMap.html#entries">entries</a></li><li data-type='method'><a href="SearchableMap.html#forEach">forEach</a></li><li data-type='method'><a href="SearchableMap.html#fuzzyGet">fuzzyGet</a></li><li data-type='method'><a href="SearchableMap.html#get">get</a></li><li data-type='method'><a href="SearchableMap.html#has">has</a></li><li data-type='method'><a href="SearchableMap.html#keys">keys</a></li><li data-type='method'><a href="SearchableMap.html#set">set</a></li><li data-type='method'><a href="SearchableMap.html#update">update</a></li><li data-type='method'><a href="SearchableMap.html#values">values</a></li></ul></li></ul>
<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/lucaong/minisearch" target="_blank" class="menu-item" id="github_repo_link" >GitHub Repository</a></h2><h3>Classes</h3><ul><li><a href="MiniSearch.html">MiniSearch</a><ul class='methods'><li data-type='method'><a href="MiniSearch.html#.getDefault">getDefault</a></li><li data-type='method'><a href="MiniSearch.html#.loadJSON">loadJSON</a></li><li data-type='method'><a href="MiniSearch.html#add">add</a></li><li data-type='method'><a href="MiniSearch.html#addAll">addAll</a></li><li data-type='method'><a href="MiniSearch.html#addAllAsync">addAllAsync</a></li><li data-type='method'><a href="MiniSearch.html#autoSuggest">autoSuggest</a></li><li data-type='method'><a href="MiniSearch.html#remove">remove</a></li><li data-type='method'><a href="MiniSearch.html#search">search</a></li><li data-type='method'><a href="MiniSearch.html#toJSON">toJSON</a></li></ul></li><li><a href="SearchableMap.html">SearchableMap</a><ul class='methods'><li data-type='method'><a href="SearchableMap.html#.from">from</a></li><li data-type='method'><a href="SearchableMap.html#.fromObject">fromObject</a></li><li data-type='method'><a href="SearchableMap.html#atPrefix">atPrefix</a></li><li data-type='method'><a href="SearchableMap.html#clear">clear</a></li><li data-type='method'><a href="SearchableMap.html#delete">delete</a></li><li data-type='method'><a href="SearchableMap.html#entries">entries</a></li><li data-type='method'><a href="SearchableMap.html#forEach">forEach</a></li><li data-type='method'><a href="SearchableMap.html#fuzzyGet">fuzzyGet</a></li><li data-type='method'><a href="SearchableMap.html#get">get</a></li><li data-type='method'><a href="SearchableMap.html#has">has</a></li><li data-type='method'><a href="SearchableMap.html#keys">keys</a></li><li data-type='method'><a href="SearchableMap.html#set">set</a></li><li data-type='method'><a href="SearchableMap.html#update">update</a></li><li data-type='method'><a href="SearchableMap.html#values">values</a></li></ul></li></ul>
</nav>

<div id="main">
Expand Down Expand Up @@ -2718,7 +2718,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 13:58:36 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 14:19:48 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down

0 comments on commit 187f5e6

Please sign in to comment.