Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/romankurnovskii/hugo-lunr-ml
Creates lunr search index file for multilingual hugo static site
https://github.com/romankurnovskii/hugo-lunr-ml
hugo hugo-search lunr npm-package
Last synced: 3 days ago
JSON representation
Creates lunr search index file for multilingual hugo static site
- Host: GitHub
- URL: https://github.com/romankurnovskii/hugo-lunr-ml
- Owner: romankurnovskii
- License: mit
- Created: 2022-07-22T11:39:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-04T16:21:03.000Z (7 months ago)
- Last Synced: 2024-04-04T17:35:56.828Z (7 months ago)
- Topics: hugo, hugo-search, lunr, npm-package
- Language: JavaScript
- Homepage: https://npmjs.com/package/hugo-lunr-ml
- Size: 824 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
hugo-lunr-ml
Package for multilingual (or not) hugo site
Generates ready to use by lunr.js `lunr-index.json` file.
[![NPM version][npm-image]][npm-url]
![npm-typescript]
[![License][github-license]][github-license-url]
[![Install size][install-size]][install-size-url]
`hugo-lunr-ml` npm package designed to enhance your Hugo site with powerful, multilingual search capabilities. This package automatically generates a `lunr-index.json` file that is ready to integrate with lunr.js, providing a seamless search experience for your Hugo site, whether it's multilingual or not.
## Features
- **Multilingual Support**: Generate search indexes in multiple languages for your Hugo site.
- **Easy Integration**: Directly integrates with lunr.js for a powerful search experience.
- **Customizable**: Offers options for custom input paths, output paths, and default languages to fit your site's structure.
## Getting Started
### Installation
Install the hugo-lunr-ml utility via [npm](https://www.npmjs.com/package/hugo-lunr-ml):
```
npm install hugo-lunr-ml
```
### Adding to Your Project
Add the following scripts to your `package.json` file. This script simplifies the generation of your search index.
**package.json**
```json
"scripts": {
"create-index": "hugo-lunr-ml"
},
```
**Configuration Options**
`hugo-lunr-ml` can be customized through various command-line options to suit your project's needs:
- `-i`: Set the input path to parse (default: `content/**`)
- `-o`: Set the output path for the index file (default: `/static/search/index.json`)
- `-l`: Set the default language. Utilizes language codes (e.g., [`.en`, `.ru`, etc] in the `index.json` (default: system language) )
- `-ol`: Set the output path for the lunr index file (default: `/static/seacrh/lunr-index.json`)
### Generating the Index
To generate your site's search index, execute the npm script you've added:
```sh
npm run create-index
```
### Integrating with lunr.js
After generating the `lunr-index.json`, you can easily integrate it with lunr.js by either installing lunr via npm:
```sh
npm install lunr
```
or including lunr.js in your Hugo template:
```html
```
Use the following JavaScript snippet to fetch and utilize the `lunr-index.json` for search:
```js
let pagesStore = {}; // Mapping for titles and URIs, e.g., {"/local-href": "post title"}
const getIndexData = async () => {
let response = await fetch(`/search/lunr-index.json`);
if (response.status !== 200) {
throw new Error("Server Error");
}
let textData = await response.text();
const idxData = JSON.parse(textData);
const lngIdx = idxData[languageMode];
const idx = lunr.Index.load(lngIdx);
pagesStore = idxData['contentMap'][languageMode];
return idx;
}
const idx = await getIndexData();
const results = idx.search('my search query');
// Example: Retrieve the first found page title
const foundUri = results[0].ref;
const foundPageTitle = pagesStore[foundUri];
```
[npm-url]: https://www.npmjs.com/package/hugo-lunr-ml
[npm-image]: https://img.shields.io/npm/v/hugo-lunr-ml
[github-license]: https://img.shields.io/github/license/romankurnovskii/hugo-lunr-ml
[github-license-url]: https://github.com/romankurnovskii/hugo-lunr-ml/blob/main/LICENSE
[npm-typescript]: https://img.shields.io/npm/types/hugo-lunr-ml
[install-size]: https://packagephobia.com/badge?p=hugo-lunr-ml
[install-size-url]: https://packagephobia.com/result?p=hugo-lunr-ml