https://github.com/dgrigg/hugo-lunr

Node module for creating lunr.js search indexes for static Hugo sites
https://github.com/dgrigg/hugo-lunr

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/dgrigg/hugo-lunr
• Owner: dgrigg
• Created: 2016-02-16T20:05:19.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-05-31T18:30:50.000Z (over 2 years ago)
• Last Synced: 2024-10-01T15:39:21.639Z (2 months ago)
• Language: JavaScript
• Size: 8.79 KB
• Stars: 71
• Watchers: 3
• Forks: 18
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred - dgrigg/hugo-lunr - Node module for creating lunr.js search indexes for static Hugo sites (others)

README

        
# hugo-lunr

## Generate lunr.js index files from Hugo static sites

A simple way to add site search to your static [Hugo](https://gohugo.io/) site using [Lunr.js](http://lunrjs.com/).

## Installation

Install the hugo-lunr utility via [npm](http://npmjs.org/):

```

$ 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

```javascript

var hugolunr = require('hugo-lunr');

new hugolunr().index();

```

or to set input/output paths

```javascript

var hugolunr = require('hugo-lunr');

var h = new hugolunr();

h.setInput('content/faq/**');

h.setOutput('public/faq.json');

h.index();

```