Builds a searchable JSON index based on Metalsmith metadata.
$ npm install metalsmith-lunr
lunr: true in file metadata to include it in the search index.
--- lunr: true title: My Article tags: maybe some tags for indexing --- My article contents...
Metalsmith-lunr can be used without options:
var lunr = ;metalsmith
Use file metadata as
fields for the search and assign weight for each field. The
content field refers Metalsmith's internal record of the files contents and should not be included in the file metadata.
var lunr = ;var lunr_ = ;lunr_;lunr_;metalsmith;
metadata search field:
metadata search reference for document
path for JSON index file
lunr pipeline functions] Functions will be called in order by lunr, see lunr doc for more information.
preprocess: a callback function that can pre-process the content of each file before it is indexed. (For example stripping HTML tags). This will not affect the content of the files themselves. The callback is passed the content as a string to it's first argument. The metadata (including the raw content buffer) can be access with
this. The callback must return a string.
Default Parameter Values
Client Side Search
//index is the parsed JSON fileidx = lunrIndexvar results = idx;