hugo-lunr-indexer

Generate Lunr indices for Hugo static sites by parsing front matter.

1.1.3
latest
Source
npm

Version published: 5 years ago

Weekly downloads: 22K; increased by10.73%

Maintainers: 1

Weekly downloads

Created: 7 years ago

Source

Hugo-Lunr-Indexer (HLI)

Generate Lunr indexes for Hugo static sites by parsing front matter.

Installation

Install with npm

$ npm install hugo-lunr-indexer

Usage

CLI

###################
# Default options #
###################

$ hli \                      # hli -> hugo-lunr-indexer
  -i "content/**" \          # input (path)
  -o "public/lunr.json" \    # output (path)
  -l "toml"                  # language (toml | yaml)
  -d "+++"                   # delimiter (toml: +++ | yaml: ---)

NPM Scripts

...
"scripts": {
  "index": "hli -i 'content/posts/**' -o 'public/indices/lunr.json' -l 'yaml' -d '---'"
},
...

$ npm run index

API

var hli = require('hugo-lunr-indexer');
var Indexer = new hli();
Indexer.setInput('content/blog/**');
Indexer.setOutput('public/static/index.json');
Indexer.setLanguage('toml');
Indexer.setDelimiter('---');
Indexer.index();

Sites using hugo-lunr-indexer

https://blog.travismclarke.com/

License

Keywords

FAQs

What is hugo-lunr-indexer?

Is hugo-lunr-indexer popular?

Is hugo-lunr-indexer well maintained?

Package last updated on 09 Jun 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install