Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

hugo-lunr-indexer

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

hugo-lunr-indexer

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

  • 1.1.3
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
22K
increased by10.73%
Maintainers
1
Weekly downloads
 
Created
Source

Hugo-Lunr-Indexer (HLI)

NPM release Build Status License

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

License

Apache-2.0 © Travis Clarke

Keywords

FAQs

Package last updated on 09 Jun 2019

Did you know?

Socket

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

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc