metalsmith-lunr

A Metalsmith plugin that integrates the Lunr.js client side search engine.

Builds a searchable JSON index based on Metalsmith metadata.

Installation

$ npm install metalsmith-lunr

Usage

Include 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 = require('metalsmith-lunr');

metalsmith.use(lunr()).

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 = require('metalsmith-lunr');
var lunr_ = require('lunr');
require('lunr-languages/lunr.stemmer.support')(lunr_);
require('lunr-languages/lunr.no')(lunr_);

metalsmith.use(lunr({
  ref: 'title',
  indexPath: 'index.json',
  fields: {
      contents: 1,
      tags: 10
  },
  pipelineFunctions: [
    lunr_.trimmer,
    lunr_.no.stopWordFilter,
    lunr_.no.stemmer
  ],
  preprocess: function(content) {
    // Replace all occurrences of __title__ with the current file's title metadata.
    return content.replace(/__title__/g, this.title);
  }
}));

Optional Parameters

• fields: {metadata search field: search weight}
• ref: metadata search reference for document
• indexPath: path for JSON index file
• pipelineFunctions: [lunr pipeline functions] Functions will be called in order by lunr, see lunr doc for more information.
• metadataWhitelist: [strings] lunr metadata that should be added to the search index objexct. ex. ["position"].
• includeFields: [strings] Metalsmith metadata that should be added to the search index object.
• 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

• fields: {contents: 1}
• ref: filePath
• indexPath: searchIndex.json
• metadataWhitelist: []
• includeFields: []

Client Side Search

Metalsmith-lunr will generate searchIndex.json. Include lunr.js in your javascript source files. Client side search example can be found here.

Once the JSON file has been parsed into javascript, simply run the following:

//index is the parsed JSON file
idx = lunr.Index.load(index)
var results = idx.search("Your Search Terms Here");

CLI Usage

{
  "plugins": {
    "metalsmith-lunr": {
      "fields": {
        "tags": 10,
        "contents": 1
      }
    }
  }
}

Tests

npm test

License

MIT