├── .gitignore ├── .npmignore ├── LICENSE ├── README.md ├── _layouts └── website │ └── page.html ├── assets ├── jquery.mark.min.js ├── search.css └── search.js ├── index.js ├── package.json └── previews ├── search1.gif ├── search2.gif └── search3.gif /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | Thumbs.db 3 | *.iml 4 | .idea/ 5 | .ipr 6 | .iws 7 | *~ 8 | ~* 9 | *.diff 10 | *.patch 11 | *.bak 12 | .project 13 | .*proj 14 | .svn/ 15 | *.swp 16 | *.pyc 17 | *.pyo 18 | .build/ 19 | bower_components/ 20 | node_modules/ 21 | *.log 22 | **/.* 23 | !.editorconfig 24 | !.gitignore 25 | !.npmignore 26 | !.cise.ym 27 | .history/ 28 | .idea/ 29 | _book/ 30 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | .idea 2 | .history 3 | *.swp 4 | /examples -------------------------------------------------------------------------------- /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 | ## gitbook-plugin-search-pro 2 | 3 | Gitbook search engine pro. (支持中文搜索) 4 | 5 | You can search any characters(utf-8) and highlight it in your GitBook, not only english(exp:Chinese). 6 | 7 | > Note: Only gitbook >= 3.0.0 support 8 | 9 | ### Demo preview 10 | 11 | ONLINE DEMO: 12 | 13 | http://gitbook-plugins.github.io/gitbook-plugin-search-pro/book/ 14 | 15 | ### GIFs 16 | 17 | --- 18 | 19 | ![](https://github.com/gitbook-plugins/gitbook-plugin-search-pro/blob/master/previews/search1.gif) 20 | 21 | --- 22 | 23 | ![](https://github.com/gitbook-plugins/gitbook-plugin-search-pro/blob/master/previews/search2.gif) 24 | 25 | --- 26 | 27 | ![](https://github.com/gitbook-plugins/gitbook-plugin-search-pro/blob/master/previews/search3.gif) 28 | 29 | --- 30 | 31 | ### Usage 32 | 33 | Before use this plugin, you should disable the default search plugin first, 34 | Here is a `book.js` configuration example: 35 | 36 | ```js 37 | { 38 | "plugins": [ 39 | "-lunr", "-search", "search-pro" 40 | ] 41 | } 42 | ``` 43 | 44 | ### Example 45 | 46 | After installed gitbook. 47 | 48 | ``` 49 | > git clone git@github.com:gitbook-plugins/gitbook-plugin-search-pro.git -b gh-pages 50 | > cd ./gitbook-plugin-search-pro 51 | > npm install 52 | > gitbook serve ./ 53 | ``` 54 | 55 | And then open http://127.0.0.1:4000 56 | 57 | 58 | ### Thanks: 59 | * [lwdgit](https://github.com/lwdgit/gitbook-plugin-search-plus) 60 | * [gitbook-plugin-lunr](https://github.com/GitbookIO/plugin-lunr) 61 | * [gitbook-plugin-search](https://github.com/GitbookIO/plugin-search) 62 | * [mark.js](https://github.com/julmot/mark.js) 63 | 64 | -------------------------------------------------------------------------------- /_layouts/website/page.html: -------------------------------------------------------------------------------- 1 | {% extends template.self %} 2 | 3 | {% block search_input %} 4 | 7 | {% endblock %} 8 | 9 | {% block search_results %} 10 |
11 |
12 | {{ super() }} 13 |
14 |
15 |
16 | {% block search_has_results %} 17 |

{{ 'SEARCH_RESULTS_TITLE'|t|safe }}

18 |
    19 | {% endblock %} 20 |
    21 |
    22 | {% block search_no_results %} 23 |

    {{ 'SEARCH_NO_RESULTS_TITLE'|t|safe }}

    24 | {% endblock %} 25 |
    26 |
    27 |
    28 | {% endblock %} -------------------------------------------------------------------------------- /assets/jquery.mark.min.js: -------------------------------------------------------------------------------- 1 | /*!*************************************************** 2 | * mark.js v8.8.0 3 | * https://github.com/julmot/mark.js 4 | * Copyright (c) 2014–2017, Julian Motz 5 | * Released under the MIT license https://git.io/vwTVl 6 | *****************************************************/ 7 | "use strict";function _classCallCheck(a,b){if(!(a instanceof b))throw new TypeError("Cannot call a class as a function")}var _extends=Object.assign||function(a){for(var b=1;b-1||d.indexOf("Trident")>-1)&&(this.ie=!0)}return _createClass(c,[{key:"log",value:function a(b){var c=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"debug",a=this.opt.log;this.opt.debug&&"object"===("undefined"==typeof a?"undefined":_typeof(a))&&"function"==typeof a[c]&&a[c]("mark.js: "+b)}},{key:"escapeStr",value:function(a){return a.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g,"\\$&")}},{key:"createRegExp",value:function(a){return a=this.escapeStr(a),Object.keys(this.opt.synonyms).length&&(a=this.createSynonymsRegExp(a)),this.opt.ignoreJoiners&&(a=this.setupIgnoreJoinersRegExp(a)),this.opt.diacritics&&(a=this.createDiacriticsRegExp(a)),a=this.createMergedBlanksRegExp(a),this.opt.ignoreJoiners&&(a=this.createIgnoreJoinersRegExp(a)),a=this.createAccuracyRegExp(a)}},{key:"createSynonymsRegExp",value:function(a){var b=this.opt.synonyms,c=this.opt.caseSensitive?"":"i";for(var d in b)if(b.hasOwnProperty(d)){var e=b[d],f=this.escapeStr(d),g=this.escapeStr(e);a=a.replace(new RegExp("("+f+"|"+g+")","gm"+c),"("+f+"|"+g+")")}return a}},{key:"setupIgnoreJoinersRegExp",value:function(a){return a.replace(/[^(|)\\]/g,function(a,b,c){var d=c.charAt(b+1);return/[(|)\\]/.test(d)||""===d?a:a+"\0"})}},{key:"createIgnoreJoinersRegExp",value:function(a){return a.split("\0").join("[\\u00ad|\\u200b|\\u200c|\\u200d]?")}},{key:"createDiacriticsRegExp",value:function(a){var b=this.opt.caseSensitive?"":"i",c=this.opt.caseSensitive?["aàáâãäåāąă","AÀÁÂÃÄÅĀĄĂ","cçćč","CÇĆČ","dđď","DĐĎ","eèéêëěēę","EÈÉÊËĚĒĘ","iìíîïī","IÌÍÎÏĪ","lł","LŁ","nñňń","NÑŇŃ","oòóôõöøō","OÒÓÔÕÖØŌ","rř","RŘ","sšśșş","SŠŚȘŞ","tťțţ","TŤȚŢ","uùúûüůū","UÙÚÛÜŮŪ","yÿý","YŸÝ","zžżź","ZŽŻŹ"]:["aÀÁÂÃÄÅàáâãäåĀāąĄăĂ","cÇçćĆčČ","dđĐďĎ","eÈÉÊËèéêëěĚĒēęĘ","iÌÍÎÏìíîïĪī","lłŁ","nÑñňŇńŃ","oÒÓÔÕÖØòóôõöøŌō","rřŘ","sŠšśŚșȘşŞ","tťŤțȚţŢ","uÙÚÛÜùúûüůŮŪū","yŸÿýÝ","zŽžżŻźŹ"],d=[];return a.split("").forEach(function(e){c.every(function(c){if(c.indexOf(e)!==-1){if(d.indexOf(c)>-1)return!1;a=a.replace(new RegExp("["+c+"]","gm"+b),"["+c+"]"),d.push(c)}return!0})}),a}},{key:"createMergedBlanksRegExp",value:function(a){return a.replace(/[\s]+/gim,"[\\s]+")}},{key:"createAccuracyRegExp",value:function(a){var b=this,c=this.opt.accuracy,d="string"==typeof c?c:c.value,e="string"==typeof c?[]:c.limiters,f="";switch(e.forEach(function(a){f+="|"+b.escapeStr(a)}),d){case"partially":default:return"()("+a+")";case"complementary":return"()([^\\s"+f+"]*"+a+"[^\\s"+f+"]*)";case"exactly":return"(^|\\s"+f+")("+a+")(?=$|\\s"+f+")"}}},{key:"getSeparatedKeywords",value:function(a){var b=this,c=[];return a.forEach(function(a){b.opt.separateWordSearch?a.split(" ").forEach(function(a){a.trim()&&c.indexOf(a)===-1&&c.push(a)}):a.trim()&&c.indexOf(a)===-1&&c.push(a)}),{keywords:c.sort(function(a,b){return b.length-a.length}),length:c.length}}},{key:"getTextNodes",value:function(a){var b=this,c="",d=[];this.iterator.forEachNode(NodeFilter.SHOW_TEXT,function(a){d.push({start:c.length,end:(c+=a.textContent).length,node:a})},function(a){return b.matchesExclude(a.parentNode)?NodeFilter.FILTER_REJECT:NodeFilter.FILTER_ACCEPT},function(){a({value:c,nodes:d})})}},{key:"matchesExclude",value:function(a){return e.matches(a,this.opt.exclude.concat(["script","style","title","head","html"]))}},{key:"wrapRangeInTextNode",value:function(a,c,d){var e=this.opt.element?this.opt.element:"mark",f=a.splitText(c),g=f.splitText(d-c),h=b.createElement(e);return h.setAttribute("data-markjs","true"),this.opt.className&&h.setAttribute("class",this.opt.className),h.textContent=f.textContent,f.parentNode.replaceChild(h,f),g}},{key:"wrapRangeInMappedTextNode",value:function(a,b,c,d,e){var f=this;a.nodes.every(function(g,h){var i=a.nodes[h+1];if("undefined"==typeof i||i.start>b){var j=function(){if(!d(g.node))return{v:!1};var i=b-g.start,j=(c>g.end?g.end:c)-g.start,k=a.value.substr(0,g.start),l=a.value.substr(j+g.start);return g.node=f.wrapRangeInTextNode(g.node,i,j),a.value=k+l,a.nodes.forEach(function(b,c){c>=h&&(a.nodes[c].start>0&&c!==h&&(a.nodes[c].start-=j),a.nodes[c].end-=j)}),c-=j,e(g.node.previousSibling,g.start),c>g.end?void(b=g.end):{v:!1}}();if("object"===("undefined"==typeof j?"undefined":_typeof(j)))return j.v}return!0})}},{key:"wrapMatches",value:function(a,b,c,d,e){var f=this,g=0===b?0:b+1;this.getTextNodes(function(b){b.nodes.forEach(function(b){b=b.node;for(var e=void 0;null!==(e=a.exec(b.textContent))&&""!==e[g];)if(c(e[g],b)){var h=e.index;if(0!==g)for(var i=1;i1&&void 0!==arguments[1])||arguments[1],d=arguments.length>2&&void 0!==arguments[2]?arguments[2]:[],e=arguments.length>3&&void 0!==arguments[3]?arguments[3]:5e3;_classCallCheck(this,a),this.ctx=b,this.iframes=c,this.exclude=d,this.iframesTimeout=e}return _createClass(a,[{key:"getContexts",value:function(){var a=void 0,c=[];return a="undefined"!=typeof this.ctx&&this.ctx?NodeList.prototype.isPrototypeOf(this.ctx)?Array.prototype.slice.call(this.ctx):Array.isArray(this.ctx)?this.ctx:"string"==typeof this.ctx?Array.prototype.slice.call(b.querySelectorAll(this.ctx)):[this.ctx]:[],a.forEach(function(a){var b=c.filter(function(b){return b.contains(a)}).length>0;c.indexOf(a)!==-1||b||c.push(a)}),c}},{key:"getIframeContents",value:function(a,b){var c=arguments.length>2&&void 0!==arguments[2]?arguments[2]:function(){},d=void 0;try{var e=a.contentWindow;if(d=e.document,!e||!d)throw new Error("iframe inaccessible")}catch(a){c()}d&&b(d)}},{key:"isIframeBlank",value:function(a){var b="about:blank",c=a.getAttribute("src").trim(),d=a.contentWindow.location.href;return d===b&&c!==b&&c}},{key:"observeIframeLoad",value:function(a,b,c){var d=this,e=!1,f=null,g=function g(){if(!e){e=!0,clearTimeout(f);try{d.isIframeBlank(a)||(a.removeEventListener("load",g),d.getIframeContents(a,b,c))}catch(a){c()}}};a.addEventListener("load",g),f=setTimeout(g,this.iframesTimeout)}},{key:"onIframeReady",value:function(a,b,c){try{"complete"===a.contentWindow.document.readyState?this.isIframeBlank(a)?this.observeIframeLoad(a,b,c):this.getIframeContents(a,b,c):this.observeIframeLoad(a,b,c)}catch(a){c()}}},{key:"waitForIframes",value:function(a,b){var c=this,d=0;this.forEachIframe(a,function(){return!0},function(a){d++,c.waitForIframes(a.querySelector("html"),function(){--d||b()})},function(a){a||b()})}},{key:"forEachIframe",value:function(b,c,d){var e=this,f=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},g=b.querySelectorAll("iframe"),h=g.length,i=0;g=Array.prototype.slice.call(g);var j=function(){--h<=0&&f(i)};h||j(),g.forEach(function(b){a.matches(b,e.exclude)?j():e.onIframeReady(b,function(a){c(b)&&(i++,d(a)),j()},j)})}},{key:"createIterator",value:function(a,c,d){return b.createNodeIterator(a,c,d,!1)}},{key:"createInstanceOnIframe",value:function(b){return new a(b.querySelector("html"),this.iframes)}},{key:"compareNodeIframe",value:function(a,b,c){var d=a.compareDocumentPosition(c),e=Node.DOCUMENT_POSITION_PRECEDING;if(d&e){if(null===b)return!0;var f=b.compareDocumentPosition(c),g=Node.DOCUMENT_POSITION_FOLLOWING;if(f&g)return!0}return!1}},{key:"getIteratorNode",value:function(a){var b=a.previousNode(),c=void 0;return c=null===b?a.nextNode():a.nextNode()&&a.nextNode(),{prevNode:b,node:c}}},{key:"checkIframeFilter",value:function(a,b,c,d){var e=!1,f=!1;return d.forEach(function(a,b){a.val===c&&(e=b,f=a.handled)}),this.compareNodeIframe(a,b,c)?(e!==!1||f?e===!1||f||(d[e].handled=!0):d.push({val:c,handled:!0}),!0):(e===!1&&d.push({val:c,handled:!1}),!1)}},{key:"handleOpenIframes",value:function(a,b,c,d){var e=this;a.forEach(function(a){a.handled||e.getIframeContents(a.val,function(a){e.createInstanceOnIframe(a).forEachNode(b,c,d)})})}},{key:"iterateThroughNodes",value:function(a,b,c,d,e){for(var f=this,g=this.createIterator(b,a,d),h=[],i=[],j=void 0,k=void 0,l=function(){var a=f.getIteratorNode(g);return k=a.prevNode,j=a.node};l();)this.iframes&&this.forEachIframe(b,function(a){return f.checkIframeFilter(j,k,a,h)},function(b){f.createInstanceOnIframe(b).forEachNode(a,c,d)}),i.push(j);i.forEach(function(a){c(a)}),this.iframes&&this.handleOpenIframes(h,a,c,d),e()}},{key:"forEachNode",value:function(a,b,c){var d=this,e=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},f=this.getContexts(),g=f.length;g||e(),f.forEach(function(f){var h=function(){d.iterateThroughNodes(a,f,b,c,function(){--g<=0&&e()})};d.iframes?d.waitForIframes(f,h):h()})}}],[{key:"matches",value:function(a,b){var c="string"==typeof b?[b]:b,d=a.matches||a.matchesSelector||a.msMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.webkitMatchesSelector;if(d){var e=!1;return c.every(function(b){return!d.call(a,b)||(e=!0,!1)}),e}return!1}}]),a}();return c.fn.mark=function(a,b){return new d(this.get()).mark(a,b),this},c.fn.markRegExp=function(a,b){return new d(this.get()).markRegExp(a,b),this},c.fn.unmark=function(a){return new d(this.get()).unmark(a),this},c},window,document); -------------------------------------------------------------------------------- /assets/search.css: -------------------------------------------------------------------------------- 1 | /* 2 | This CSS only styled the search results section, not the search input 3 | It defines the basic interraction to hide content when displaying results, etc 4 | */ 5 | #book-search-input { 6 | background: inherit; 7 | } 8 | #book-search-results .search-results { 9 | display: none; 10 | } 11 | #book-search-results .search-results ul.search-results-list { 12 | list-style-type: none; 13 | padding-left: 0; 14 | } 15 | #book-search-results .search-results ul.search-results-list li { 16 | margin-bottom: 1.5rem; 17 | padding-bottom: 0.5rem; 18 | /* Highlight results */ 19 | } 20 | #book-search-results .search-results ul.search-results-list li p em { 21 | background-color: rgba(255, 220, 0, 0.4); 22 | font-style: normal; 23 | } 24 | #book-search-results .search-results .no-results { 25 | display: none; 26 | } 27 | #book-search-results.open .search-results { 28 | display: block; 29 | } 30 | #book-search-results.open .search-noresults { 31 | display: none; 32 | } 33 | #book-search-results.no-results .search-results .has-results { 34 | display: none; 35 | } 36 | #book-search-results.no-results .search-results .no-results { 37 | display: block; 38 | } 39 | #book-search-results span.search-highlight-keyword { 40 | background: #ff0; 41 | } 42 | -------------------------------------------------------------------------------- /assets/search.js: -------------------------------------------------------------------------------- 1 | require([ 2 | 'gitbook', 3 | 'jquery' 4 | ], function(gitbook, $) { 5 | var MAX_DESCRIPTION_SIZE = 500; 6 | var state = gitbook.state; 7 | var INDEX_DATA = {}; 8 | var usePushState = (typeof history.pushState !== 'undefined'); 9 | 10 | // DOM Elements 11 | var $body = $('body'); 12 | var $bookSearchResults; 13 | var $searchList; 14 | var $searchTitle; 15 | var $searchResultsCount; 16 | var $searchQuery; 17 | 18 | // Throttle search 19 | function throttle(fn, wait) { 20 | var timeout; 21 | 22 | return function() { 23 | var ctx = this, 24 | args = arguments; 25 | if (!timeout) { 26 | timeout = setTimeout(function() { 27 | timeout = null; 28 | fn.apply(ctx, args); 29 | }, wait); 30 | } 31 | }; 32 | } 33 | 34 | function displayResults(res) { 35 | $bookSearchResults = $('#book-search-results'); 36 | $searchList = $bookSearchResults.find('.search-results-list'); 37 | $searchTitle = $bookSearchResults.find('.search-results-title'); 38 | $searchResultsCount = $searchTitle.find('.search-results-count'); 39 | $searchQuery = $searchTitle.find('.search-query'); 40 | 41 | $bookSearchResults.addClass('open'); 42 | 43 | var noResults = res.count == 0; 44 | $bookSearchResults.toggleClass('no-results', noResults); 45 | 46 | // Clear old results 47 | $searchList.empty(); 48 | 49 | // Display title for research 50 | $searchResultsCount.text(res.count); 51 | $searchQuery.text(res.query); 52 | 53 | // Create an
  • element for each result 54 | res.results.forEach(function(item) { 55 | var $li = $('
  • ', { 56 | 'class': 'search-results-item' 57 | }); 58 | 59 | var $title = $('

    '); 60 | 61 | var $link = $('', { 62 | 'href': gitbook.state.basePath + '/' + item.url + '?h=' + encodeURIComponent(res.query), 63 | 'text': item.title, 64 | 'data-is-search': 1 65 | }); 66 | 67 | if ($link[0].href.split('?')[0] === location.href.split('?')[0]) { 68 | $link[0].setAttribute('data-need-reload', 1); 69 | } 70 | 71 | var content = item.body.trim(); 72 | if (content.length > MAX_DESCRIPTION_SIZE) { 73 | content = content + '...'; 74 | } 75 | var $content = $('

    ').html(content); 76 | 77 | $link.appendTo($title); 78 | $title.appendTo($li); 79 | $content.appendTo($li); 80 | $li.appendTo($searchList); 81 | }); 82 | $('.body-inner').scrollTop(0); 83 | } 84 | 85 | function escapeReg(keyword) { 86 | //escape regexp prevserve word 87 | return String(keyword).replace(/([\*\.\?\+\$\^\[\]\(\)\{\}\|\/\\])/g, '\\$1'); 88 | } 89 | 90 | function query(keyword) { 91 | if (keyword == null || keyword.trim() === '') return; 92 | 93 | var results = [], 94 | index = -1; 95 | for (var page in INDEX_DATA) { 96 | if ((index = INDEX_DATA[page].body.toLowerCase().indexOf(keyword.toLowerCase())) !== -1) { 97 | results.push({ 98 | url: page, 99 | title: INDEX_DATA[page].title, 100 | body: INDEX_DATA[page].body.substr(Math.max(0, index - 50), MAX_DESCRIPTION_SIZE).replace(new RegExp('(' + escapeReg(keyword) + ')', 'gi'), '$1') 101 | }); 102 | } 103 | } 104 | displayResults({ 105 | count: results.length, 106 | query: keyword, 107 | results: results 108 | }); 109 | } 110 | 111 | function launchSearch(keyword) { 112 | // Add class for loading 113 | $body.addClass('with-search'); 114 | $body.addClass('search-loading'); 115 | 116 | function doSearch() { 117 | query(keyword); 118 | $body.removeClass('search-loading'); 119 | } 120 | 121 | throttle(doSearch)(); 122 | } 123 | 124 | function closeSearch() { 125 | $body.removeClass('with-search'); 126 | $('#book-search-results').removeClass('open'); 127 | } 128 | 129 | function bindSearch() { 130 | // Bind DOM 131 | var $body = $('body'); 132 | 133 | // Launch query based on input content 134 | function handleUpdate() { 135 | var $searchInput = $('#book-search-input input'); 136 | var keyword = $searchInput.val(); 137 | 138 | if (keyword.length == 0) { 139 | closeSearch(); 140 | } else { 141 | launchSearch(keyword); 142 | } 143 | } 144 | 145 | $body.on('keyup', '#book-search-input input', function(e) { 146 | if (e.keyCode === 13) { 147 | if (usePushState) { 148 | var uri = updateQueryString('q', $(this).val()); 149 | history.pushState({ 150 | path: uri 151 | }, null, uri); 152 | } 153 | } 154 | handleUpdate(); 155 | }); 156 | 157 | // Push to history on blur 158 | $body.on('blur', '#book-search-input input', function(e) { 159 | // Update history state 160 | if (usePushState) { 161 | var uri = updateQueryString('q', $(this).val()); 162 | history.pushState({ 163 | path: uri 164 | }, null, uri); 165 | } 166 | }); 167 | } 168 | 169 | gitbook.events.on('start', function() { 170 | bindSearch(); 171 | $.getJSON(state.basePath + "/search_plus_index.json").then(function(data) { 172 | INDEX_DATA = data; 173 | showResult(); 174 | closeSearch(); 175 | }); 176 | }); 177 | 178 | // 高亮文本 179 | var highLightPageInner = function(keyword) { 180 | $('.page-inner').mark(keyword, { 181 | 'ignoreJoiners': true, 182 | 'acrossElements': true, 183 | 'separateWordSearch': false 184 | }); 185 | 186 | setTimeout(function() { 187 | var mark = $('mark[data-markjs="true"]'); 188 | if (mark.length) { 189 | mark[0].scrollIntoView(); 190 | } 191 | }, 100); 192 | }; 193 | 194 | function showResult() { 195 | var keyword, type; 196 | if (/\b(q|h)=([^&]+)/.test(location.search)) { 197 | type = RegExp.$1; 198 | keyword = decodeURIComponent(RegExp.$2); 199 | if (type === 'q') { 200 | launchSearch(keyword); 201 | } else { 202 | highLightPageInner(keyword); 203 | } 204 | $('#book-search-input input').val(keyword); 205 | } 206 | } 207 | 208 | gitbook.events.on('page.change', showResult); 209 | 210 | function getParameterByName(name) { 211 | var url = window.location.href; 212 | name = name.replace(/[\[\]]/g, '\\$&'); 213 | var regex = new RegExp('[?&]' + name + '(=([^&#]*)|&|#|$)', 'i'), 214 | results = regex.exec(url); 215 | if (!results) return null; 216 | if (!results[2]) return ''; 217 | return decodeURIComponent(results[2].replace(/\+/g, ' ')); 218 | } 219 | 220 | function updateQueryString(key, value) { 221 | value = encodeURIComponent(value); 222 | 223 | var url = window.location.href.replace(/([?&])(?:q|h)=([^&]+)(&|$)/, function(all, pre, value, end) { 224 | if (end === '&') { 225 | return pre; 226 | } 227 | return ''; 228 | }); 229 | var re = new RegExp('([?&])' + key + '=.*?(&|#|$)(.*)', 'gi'), 230 | hash; 231 | 232 | if (re.test(url)) { 233 | if (typeof value !== 'undefined' && value !== null) 234 | return url.replace(re, '$1' + key + '=' + value + '$2$3'); 235 | else { 236 | hash = url.split('#'); 237 | url = hash[0].replace(re, '$1$3').replace(/(&|\?)$/, ''); 238 | if (typeof hash[1] !== 'undefined' && hash[1] !== null) 239 | url += '#' + hash[1]; 240 | return url; 241 | } 242 | } else { 243 | if (typeof value !== 'undefined' && value !== null) { 244 | var separator = url.indexOf('?') !== -1 ? '&' : '?'; 245 | hash = url.split('#'); 246 | url = hash[0] + separator + key + '=' + value; 247 | if (typeof hash[1] !== 'undefined' && hash[1] !== null) 248 | url += '#' + hash[1]; 249 | return url; 250 | } else 251 | return url; 252 | } 253 | } 254 | window.addEventListener('click', function(e) { 255 | if (e.target.tagName === 'A' && e.target.getAttribute('data-need-reload')) { 256 | setTimeout(function() { 257 | location.reload(); 258 | }, 100); 259 | } 260 | }, true); 261 | }); -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var Entities = require('html-entities').AllHtmlEntities; 2 | 3 | var Html = new Entities(); 4 | 5 | // Map of Lunr ref to document 6 | var documentsStore = {}; 7 | 8 | module.exports = { 9 | book: { 10 | assets: './assets', 11 | js: [ 12 | 'jquery.mark.min.js', 13 | 'search.js' 14 | ], 15 | css: [ 16 | 'search.css' 17 | ] 18 | }, 19 | 20 | hooks: { 21 | // Index each page 22 | 'page': function(page) { 23 | if (this.output.name != 'website' || page.search === false) { 24 | return page; 25 | } 26 | 27 | var text; 28 | 29 | this.log.debug.ln('index page', page.path); 30 | 31 | text = page.content; 32 | // Decode HTML 33 | text = Html.decode(text); 34 | // Strip HTML tags 35 | text = text.replace(/(<([^>]+)>)/ig, ''); 36 | text = text.replace(/[\n ]+/g, ' '); 37 | var keywords = []; 38 | if (page.search) { 39 | keywords = page.search.keywords || []; 40 | } 41 | 42 | // Add to index 43 | var doc = { 44 | url: this.output.toURL(page.path), 45 | title: page.title, 46 | summary: page.description, 47 | keywords: keywords.join(' '), 48 | body: text 49 | }; 50 | 51 | documentsStore[doc.url] = doc; 52 | 53 | return page; 54 | }, 55 | 56 | // Write index to disk 57 | 'finish': function() { 58 | if (this.output.name != 'website') return; 59 | 60 | this.log.debug.ln('write search index'); 61 | return this.output.writeFile('search_plus_index.json', JSON.stringify(documentsStore)); 62 | } 63 | } 64 | }; -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gitbook-plugin-search-pro", 3 | "version": "2.0.2", 4 | "description": "Gitbook search engine pro. (支持中文搜索)", 5 | "author": { 6 | "name": "xunuo", 7 | "email": "i@xunuo.com" 8 | }, 9 | "repository": "gitbook-plugins/gitbook-plugin-search-pro", 10 | "keywords": [ 11 | "中文", 12 | "搜索", 13 | "chinese", 14 | "gitbook", 15 | "search", 16 | "utf-8" 17 | ], 18 | "engines": { 19 | "gitbook": ">=3.0.0" 20 | }, 21 | "dependencies": { 22 | "html-entities": "1.2.0" 23 | }, 24 | "analyze": true, 25 | "license": "MIT", 26 | "homepage": "https://xunuo.com" 27 | } 28 | -------------------------------------------------------------------------------- /previews/search1.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gitbook-plugins/gitbook-plugin-search-pro/9e9e86c1b54c8363d75d309713d3d502a36bcdcf/previews/search1.gif -------------------------------------------------------------------------------- /previews/search2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gitbook-plugins/gitbook-plugin-search-pro/9e9e86c1b54c8363d75d309713d3d502a36bcdcf/previews/search2.gif -------------------------------------------------------------------------------- /previews/search3.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gitbook-plugins/gitbook-plugin-search-pro/9e9e86c1b54c8363d75d309713d3d502a36bcdcf/previews/search3.gif --------------------------------------------------------------------------------