Installation instructions should be improved and clarified

[russellcameronthomas]

I have had difficulty in following your installation instructions. In my opinion, they are poorly worded and imprecise. All instructions should be unambiguous. Please don't assume that anything is obvious. No steps should be omitted.

For example:

Step 4: Add a search form with a query input as shown.

Add the "search form" where? On what page or pages?

Step 5. Add an element to contain the list of search result entries.

Add the "search result" element where? I'm guessing on a NEW HTML page in the root directory, named: search.html

Step 6. Create a Mustache template to display the search results.

Where does this go? In a separate file in _includes folder? or as part of the search.html file?

Step 7. Configure the jQuery plugin for the search input field.

Is this step required or optional?

Step 9. Stop Words

Is this step required or optional?

Step 10. Alternate data directory

Is this step required or optional?

[russellcameronthomas]

Another example:

"The content from all Jekyll posts and pages will be indexed to a js/index.json file ready for lunr.js to consume. This happens each time the site is generated"

You never explain how the index.json file is generated. Is it done automatically as part of the jekyll serve command? That does not seem to be happening for me, although I cannot prove that I have everything configured properly due to other ambiguities in the instructions.

I do get these error messages in the console: 2016-11-23 05:48:26] ERROR `/js/index.json' not found.

[slashdotdash]

@russellcameronthomas I appreciate any help you can provide to clarify the parts of the README you've found confusing. Pull requests gladly accepted.

[russellcameronthomas]

OK. I'll put some effort into it in a few weeks, after my next deadlines.

[Bahar1978]

Dear @slashdotdash and @russellcameronthomas,

I am going to index a number of html files in a json format that can be used by jeklii-lunr.js I have spent a couple of hours to set up jeklii-lunr.js, but so far it does not work .... Could you please let me know some hint in order to make me it working. I have a folder of for example 10 html files. I also have an index.html file that can load those 10 html files. What I want to do is to search on my those 10 html files via my index.html file using jeklii-lunr.js. Thanks in advance for you help.