https://github.com/triole/lunr-indexer
lunr-indexer builds a lunar search index from all md files inside a folder, it comes along as static binary
https://github.com/triole/lunr-indexer
indexer lunr search-engine
Last synced: 9 months ago
JSON representation
lunr-indexer builds a lunar search index from all md files inside a folder, it comes along as static binary
- Host: GitHub
- URL: https://github.com/triole/lunr-indexer
- Owner: triole
- Created: 2021-06-12T07:58:02.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-28T17:03:35.000Z (over 1 year ago)
- Last Synced: 2024-11-28T17:32:00.216Z (over 1 year ago)
- Topics: indexer, lunr, search-engine
- Language: Go
- Homepage:
- Size: 43.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Lunr Indexer  
- [Synopsis](#synopsis)
- [Index JSON Layout](#index-json-layout)
- [Help & Usage](#help--usage)
- [Disclaimer](#disclaimer)
## Synopsis
Lunr Indexer recursively finds all markdown files inside a directory and builds a [lunrjs](https://lunrjs.com/) search index from them. It is blazingly fast and can run a watcher that reindexes automatically on changes inside the folder.
## Index JSON Layout
To check the layout of the resulting index json have a look at the test data inside the repo. For example [here](https://github.com/triole/lunr-indexer/blob/master/testdata/set1/assert.json).
## Help & Usage
For help and more information consider running
```shell
# simple usage
$ lunr-indexer /path/to/md_files
# custom output file
$ lunr-indexer /path/to/md_files -o /path/to/output.json
# running the watcher
$ lunr-indexer /path/to/md_files -w
# help and more information
$ lunr-indexer -h
```
## Disclaimer
Warning. Use this software at your own risk. I may not be hold responsible for any data loss, starving your kittens or losing the bling bling powerpoint presentation you made to impress human resources with the efficiency of your employee's performance.