Skip to content

Commit

Permalink
:x
Browse files Browse the repository at this point in the history
  • Loading branch information
tlienart committed Aug 24, 2021
2 parents 193a099 + 41045d4 commit b654fc9
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/extras/lunr.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Once it's working, you might want to adjust the `build_index.js` and/or the `lu

### Libraries

Install `lunr` and `cheerio` (a HTML parser) with `node`:
Install `lunr` and `cheerio` (a HTML parser) with `node` locally:

```bash
$> npm install lunr
Expand All @@ -25,7 +25,7 @@ $> npm install cheerio
### Files

Copy [this folder](https://github.com/tlienart/Franklin.jl/tree/master/docs/_libs/lunr) to a `/_libs/lunr/` directory.
Discard the `lunr_index.js` which is the index of this website, you will rebuild your own of course!
Discard the `lunr_index.js` which is the index of this website, a version for your website will be generated dynamically.

The important files are `build_index.js` and `lunrclient.js` (of which a minified version is provided which you will want to re-generate if you modify the base file).
These files are adapted from [this repository](https://github.com/BLE-LTER/Lunr-Index-and-Search-for-Static-Sites) which shows how to use Lunr on a static website.
Expand Down

0 comments on commit b654fc9

Please sign in to comment.