├── .gitignore ├── .npmignore ├── LICENSE ├── README.md ├── assets └── search-lunr.js ├── index.js └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Directory for instrumented libs generated by jscoverage/JSCover 11 | lib-cov 12 | 13 | # Coverage directory used by tools like istanbul 14 | coverage 15 | 16 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 17 | .grunt 18 | 19 | # Compiled binary addons (http://nodejs.org/api/addons.html) 20 | build/Release 21 | 22 | # Dependency directory 23 | # Deployed apps should consider commenting this line out: 24 | # see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git 25 | node_modules 26 | 27 | # vim swapfile 28 | *.swp 29 | 30 | assets/lunr.min.js 31 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | !assets/lunr.min.js 2 | 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # lunr 2 | 3 | This plugin provides a backend for the [search](https://github.com/GitbookIO/plugin-search) plugin. 4 | 5 | This plugin is a default plugin. 6 | 7 | ### Disable this plugin 8 | 9 | This is a default plugin and it can be disabled using a `book.json` configuration: 10 | 11 | ```js 12 | { 13 | "plugins": ["-lunr"] 14 | } 15 | ``` 16 | 17 | ### Limitations 18 | 19 | Lunr can't index a huge book, by default the index size is limited at ~100ko. 20 | 21 | You can change this limit by settings the configuration `maxIndexSize`: 22 | 23 | ```js 24 | { 25 | "pluginsConfig": { 26 | "lunr": { 27 | "maxIndexSize": 200000 28 | } 29 | } 30 | } 31 | ``` 32 | 33 | ### Adding keywords to a page 34 | 35 | You can specify explicit keywords for any page. When searching for these keywords, the page will rank higher in the results. 36 | 37 | ```md 38 | --- 39 | search: 40 | keywords: ['keyword1', 'keyword2', 'etc.'] 41 | 42 | --- 43 | 44 | # My Page 45 | 46 | This page will rank better if we search for 'keyword1'. 47 | ``` 48 | 49 | ### Disabling indexing of a page 50 | 51 | You can disable the indexing of a specific page by adding a YAML header to the page: 52 | 53 | ```md 54 | --- 55 | search: false 56 | --- 57 | 58 | # My Page 59 | 60 | This page is not indexed in Lunr. 61 | ``` 62 | 63 | ### Ignoring special characters 64 | 65 | By default, special characters will be taken into account, to allow special searches like "C++" or "#word". You can disable this if your text is essentially English prose with the `ignoreSpecialCharacters` option: 66 | 67 | 68 | ```js 69 | { 70 | "pluginsConfig": { 71 | "lunr": { 72 | "ignoreSpecialCharacters": true 73 | } 74 | } 75 | } 76 | ``` 77 | -------------------------------------------------------------------------------- /assets/search-lunr.js: -------------------------------------------------------------------------------- 1 | require([ 2 | 'gitbook', 3 | 'jquery' 4 | ], function(gitbook, $) { 5 | // Define global search engine 6 | function LunrSearchEngine() { 7 | this.index = null; 8 | this.store = {}; 9 | this.name = 'LunrSearchEngine'; 10 | } 11 | 12 | // Initialize lunr by fetching the search index 13 | LunrSearchEngine.prototype.init = function() { 14 | var that = this; 15 | var d = $.Deferred(); 16 | 17 | $.getJSON(gitbook.state.basePath+'/search_index.json') 18 | .then(function(data) { 19 | // eslint-disable-next-line no-undef 20 | that.index = lunr.Index.load(data.index); 21 | that.store = data.store; 22 | d.resolve(); 23 | }); 24 | 25 | return d.promise(); 26 | }; 27 | 28 | // Search for a term and return results 29 | LunrSearchEngine.prototype.search = function(q, offset, length) { 30 | var that = this; 31 | var results = []; 32 | 33 | if (this.index) { 34 | results = $.map(this.index.search(q), function(result) { 35 | var doc = that.store[result.ref]; 36 | 37 | return { 38 | title: doc.title, 39 | url: doc.url, 40 | body: doc.summary || doc.body 41 | }; 42 | }); 43 | } 44 | 45 | return $.Deferred().resolve({ 46 | query: q, 47 | results: results.slice(0, length), 48 | count: results.length 49 | }).promise(); 50 | }; 51 | 52 | // Set gitbook research 53 | gitbook.events.bind('start', function(e, config) { 54 | var engine = gitbook.search.getEngine(); 55 | if (!engine) { 56 | gitbook.search.setEngine(LunrSearchEngine, config); 57 | } 58 | }); 59 | }); 60 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var lunr = require('lunr'); 2 | var Entities = require('html-entities').AllHtmlEntities; 3 | 4 | var Html = new Entities(); 5 | 6 | var searchIndex; 7 | // Called with the `this` context provided by Gitbook 8 | function getSearchIndex(context) { 9 | if (!searchIndex) { 10 | // Create search index 11 | var ignoreSpecialCharacters = context.config.get('pluginsConfig.lunr.ignoreSpecialCharacters') || context.config.get('lunr.ignoreSpecialCharacters'); 12 | searchIndex = lunr(function () { 13 | this.ref('url'); 14 | 15 | this.field('title', { boost: 10 }); 16 | this.field('keywords', { boost: 15 }); 17 | this.field('body'); 18 | 19 | if (!ignoreSpecialCharacters) { 20 | // Don't trim non words characters (to allow search such as "C++") 21 | this.pipeline.remove(lunr.trimmer); 22 | } 23 | }); 24 | } 25 | return searchIndex; 26 | } 27 | 28 | // Map of Lunr ref to document 29 | var documentsStore = {}; 30 | 31 | var searchIndexEnabled = true; 32 | var indexSize = 0; 33 | 34 | module.exports = { 35 | book: { 36 | assets: './assets', 37 | js: [ 38 | 'lunr.min.js', 'search-lunr.js' 39 | ] 40 | }, 41 | 42 | hooks: { 43 | // Index each page 44 | 'page': function(page) { 45 | if (this.output.name != 'website' || !searchIndexEnabled || page.search === false) { 46 | return page; 47 | } 48 | 49 | var text, maxIndexSize; 50 | maxIndexSize = this.config.get('pluginsConfig.lunr.maxIndexSize') || this.config.get('lunr.maxIndexSize'); 51 | 52 | this.log.debug.ln('index page', page.path); 53 | 54 | text = page.content; 55 | // Decode HTML 56 | text = Html.decode(text); 57 | // Strip HTML tags 58 | text = text.replace(/(<([^>]+)>)/ig, ''); 59 | 60 | indexSize = indexSize + text.length; 61 | if (indexSize > maxIndexSize) { 62 | this.log.warn.ln('search index is too big, indexing is now disabled'); 63 | searchIndexEnabled = false; 64 | return page; 65 | } 66 | 67 | var keywords = []; 68 | if (page.search) { 69 | keywords = page.search.keywords || []; 70 | } 71 | 72 | // Add to index 73 | var doc = { 74 | url: this.output.toURL(page.path), 75 | title: page.title, 76 | summary: page.description, 77 | keywords: keywords.join(' '), 78 | body: text 79 | }; 80 | 81 | documentsStore[doc.url] = doc; 82 | getSearchIndex(this).add(doc); 83 | 84 | return page; 85 | }, 86 | 87 | // Write index to disk 88 | 'finish': function() { 89 | if (this.output.name != 'website') return; 90 | 91 | this.log.debug.ln('write search index'); 92 | return this.output.writeFile('search_index.json', JSON.stringify({ 93 | index: getSearchIndex(this), 94 | store: documentsStore 95 | })); 96 | } 97 | } 98 | }; 99 | 100 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gitbook-plugin-lunr", 3 | "description": "Index book in a lunr index accessible from the search plugin", 4 | "main": "index.js", 5 | "version": "1.2.0", 6 | "engines": { 7 | "gitbook": ">=3.0.0-pre.0" 8 | }, 9 | "dependencies": { 10 | "gitbook-plugin-search": "*", 11 | "html-entities": "1.2.0", 12 | "lunr": "0.5.12" 13 | }, 14 | "homepage": "https://github.com/GitbookIO/plugin-lunr", 15 | "repository": { 16 | "type": "git", 17 | "url": "https://github.com/GitbookIO/plugin-lunr.git" 18 | }, 19 | "license": "Apache-2.0", 20 | "bugs": { 21 | "url": "https://github.com/GitbookIO/plugin-lunr/issues" 22 | }, 23 | "gitbook": { 24 | "properties": { 25 | "maxIndexSize": { 26 | "type": "number", 27 | "title": "Limit size for the index", 28 | "default": 1000000 29 | }, 30 | "ignoreSpecialCharacters": { 31 | "type": "boolean", 32 | "title": "Ignore special characters in words", 33 | "default": false 34 | } 35 | } 36 | }, 37 | "scripts": { 38 | "prepublish": "cp node_modules/lunr/lunr.min.js ./assets/lunr.min.js" 39 | } 40 | } 41 | --------------------------------------------------------------------------------