Add search functionality for docs

BZFlag-Dev / bzflag.org

The bzflag.org static website

https://www.bzflag.org

MIT License

8 stars 7 forks source link

Add search functionality for docs #21

Closed allejo closed 5 years ago

allejo commented 5 years ago

Since we're a static site and we need a way to be able to search the documentation, a JS-based version is the best way to go. I'm using Lunr.js for indexing all our collections and rendering it all through good old vanilla JS.

Task List

[x] Add Search link or input field throughout the site and navigation

Closes #19

allejo commented 5 years ago

Marking as blocked for now while we investigate more; see https://github.com/olivernn/lunr.js/issues/370

Basically, searching *compiling* will not return the same results as searching compiling. This appears to be a lunr.js bug. We would need to find a fix or a workaround.

jwmelto commented 5 years ago

I'm not qualified to review this, since I'm not familiar with these technologies. I'm marginal in raw Javascript. I don't see anything that jumps out at me.