Potential improvements to make to the `README` about antora-lunr HOT 1 CLOSED

Thanks, I followed the README and got lunr integrated on my Antora 2.0 development setup.

Well done 🚀

This is now site/search_index.json.

Actually it depends on your configuration.
If your configuration is:

output:
  dir: ./public

Then I'm right 😉
But I agree we should probably, say "an index file should be created at the root of your output directory". We could go one step further and explain that the output directory is configured in the playbook with the output.dir key ?

Something like "Use the following URL..." would be clearer.

👍

I couldn't make any progress when attempting to use a file:// reference.

Technically it can work if you disable web security and allow file access from the file protocol. But we should probably rephrase.
Having said that I need to do some testings to see if we can get it work without a local web server (and without running the browser with additional flags).

Please feel free to open a pull request to clarify the README, I will gladly merge your contribution 😄

from antora-lunr.