1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/* eslint-disable no-var, object-shorthand */
var lunr = require('lunr');
var Entities = require('html-entities').AllHtmlEntities;
var Html = new Entities();
var searchIndex;
// Called with the `this` context provided by Gitbook
function getSearchIndex(context) {
if (!searchIndex) {
// Create search index
var ignoreSpecialCharacters = (
context.config.get('pluginsConfig.lunr.ignoreSpecialCharacters')
|| context.config.get('lunr.ignoreSpecialCharacters')
);
searchIndex = lunr(function() {
this.ref('url');
this.field('title', { boost: 10 });
this.field('keywords', { boost: 15 });
this.field('body');
if (!ignoreSpecialCharacters) {
// Don't trim non words characters (to allow search such as "C++")
this.pipeline.remove(lunr.trimmer);
}
});
}
return searchIndex;
}
// Map of Lunr ref to document
var documentsStore = {};
var searchIndexEnabled = true;
var indexSize = 0;
module.exports = {
hooks: {
// Index each page
'page': function(page) {
const search = page.attributes.search;
if (this.output.name != 'website' || !searchIndexEnabled || search === false) {
return page;
}
var text, maxIndexSize;
maxIndexSize = this.config.get('pluginsConfig.lunr.maxIndexSize') || this.config.get('lunr.maxIndexSize');
this.log.debug.ln('index page', page.path);
text = page.content;
// Decode HTML
text = Html.decode(text);
// Strip HTML tags
text = text.replace(/(<([^>]+)>)/ig, '');
indexSize = indexSize + text.length;
if (indexSize > maxIndexSize) {
this.log.warn.ln('search index is too big, indexing is now disabled');
searchIndexEnabled = false;
return page;
}
var keywords = [];
if (search) {
keywords = search.keywords || [];
}
// Add to index
var doc = {
url: this.output.toURL(page.path),
title: page.title,
summary: page.description,
keywords: keywords.join(' '),
body: text
};
documentsStore[doc.url] = doc;
getSearchIndex(this).add(doc);
return page;
},
// Write index to disk
'finish': function() {
if (this.output.name != 'website') return;
this.log.debug.ln('write search index');
return this.output.writeFile('search_index.json', JSON.stringify({
index: getSearchIndex(this),
store: documentsStore
}));
}
}
};
|
