feat: Add offline search #120
Conversation
|
I also added some HTML and CSS fixes that I did not saw earlier |
|
For now the search engine is not really offline since load Lunr.js from unpkg.com. I think that for now it's better for cache management, but we'll have to improve it if we want to make it downloadable locally. |
taorepoara
requested review from
Nesqwik,
jonas-martinez,
shiipou and
pichoemr
|
@taorepoara I can't make the search system work on my computer. Maybe something needs to be run before ? If so, please add the commands to the README. |
|
@jonas-martinez Have you tried with the Nginx target ? The |
|
@taorepoara It stays stuck in the "Starting NGINX" step. I have run the npm run build so I don't understand what I'm missing. |
Have you try to go to https://localhost:8080 after that ? I'll had more explanation in the doc |
|
@taorepoara Yes, it doesn't work even when exposing the port 8080. |
|
@jonas-martinez It might be due to the macOS config. We'll have to debug it together |
|
🎉 This PR is included in version 1.0.0-beta.24 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Closes #115
Description of the changes
In order to make it easier to find what you're looking for in the documentation, I've added a search form.
Checklist
I included unit tests that cover my changes
I added/updated the documentation about my changes
Technical highlight/advice
I've used the Lunr.js search engine. The search index is generated during the Nginx website generation and it's based on the previously generated HTML pages.
In order to display the search results we need to have the target page content. I load this content when the page is in the results (and not previously loaded).
For this first implementation this only work for the Nginx target (the production one). It would have been much less efficient to handle for the Express target since we would have to regerate the search index at every page load which needs to rendre every HTML pages.