dgrigg / hugo-lunr

Node module for creating lunr.js search indexes for static Hugo sites

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 and output path/file -o.

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.index();

hugo-lunr's Issues

Expects hugo to be built

The script fails when the public directory is not (yet) present.

Access Denied

I am getting an access denied error when I navigate to the https://lunrjs.com/example/ page.

Option to include/exclude draft content

For deployment I use hugo without the -D draft flag. As far as I can tell draft content is excluded from the index. While developing a site I often mark content with draft: true in the front matter and run hugo -D server on my local machine. It would be nice if there was an option to include draft content in the search index.

Alternative Now Available

If you're looking for an alternative to this tool (given that it's unmaintained) - I've written a command line tool in Rust that does the same job. Pull/feature requests are welcome.

Custom permalinks

This generates an index file with the default permalink structure. If you use anything other than the default setting, the search results will go to 404 errors.