hugo-lunr

Generate lunr.js index files from Hugo static sites

A simple way to add site search to your static Hugo site using Lunr.js.

Installation

Install the hugo-lunr utility via npm:

$ npm install hugo-lunr

Options

By default hugo-lunr will read the content directory of you and output the lunr index to public/lunr.json. If you are using the command line implementation you can pass an input directory -i and an output path/file -o.

Exclude folders

To exclude folders within your input directory, you can pass comma-separated glob patterns with the --excludes parameter, e.g.

hugo-lunr -i \"content/subdir/**\" -o public/my-index.json --excludes \"content/images/**\"

Note that the API version of this flag (setExcludes()) can accept a comma-separated string or an array of glob patterns.

Content file options

Using the --fileopts CLI flag or setFileOpts() API method, you can specify these options when reading content files:

Key	Default	Desc
matter	{delims: '+++', lang:'toml'}	Options for reading front matter
taxonomies	['tags']	Array of taxonomies to include in index
indexDrafts	false	Whether to include draft posts when building search index. Note that future-dated posts will be indexed (PRs welcome...)
params	[]	Array of any other parameters to include in index, e.g. date
callback	null	Callback function to transform the output of reading each file. Can be used only with API

You can provide the path to a JSON file using CLI flag or API, or just pass an object directly when calling the API method.

How to use hugo-lunr CLI

The easiest way to use hugo-lunr is via npm scripts:

  "scripts": {
    "index": "hugo-lunr"
  },

or to pass arguments for input and output:

  "scripts": {
    "index": "hugo-lunr -i \"content/subdir/**\" -o public/my-index.json"
  },

Which can be executed from a terminal prompt

$ npm run index

How to use hugo-lunr API

var hugolunr = require('hugo-lunr');
new hugolunr().index();

or to set input/output paths

var hugolunr = require('hugo-lunr');
var h = new hugolunr();
h.setInput('content/faq/**');
h.setOutput('public/faq.json');
h.setExcludes(['content/faq/images/**', 'content/faq/subdir/assets/**']);
h.setFileOpts({ taxonomies: ['tags', 'categories'] });
h.index();