experimental-software / workshop-materials

Hugo theme for building websites for IT workshops with tutorials and presentations
https://experimental-software.github.io/workshop-materials
MIT License
0 stars 0 forks source link

Add support for search #13

Open jmewes opened 3 years ago

jmewes commented 3 years ago

If there are lots of tutorials, then a search functionality might be useful.

See https://gohugo.io/tools/search/ for hints how this could be done.

jmewes commented 3 years ago

The goal of the Workshop Materials project is to provide a simplistic tool for the creation of presentations and tutorials which can be used as supporting material workshops of IT topics.

The link in the issue description show some possible means to add a JavaScript based search to Hugo projects. However, to generate the index, e.g. for lunrjs, there is a need for a scripting language. The examples show the index creation with JavaScript but also Python or other scripting languages should be possible. While it would be possible to get this up-and-running, it would defeat the project's advantage that it has minimal dependencies and is super-easy to setup.

Further, the Workshop Materials project is not intended to provide massive amounts of documentation. So all the content should be reachable via the navigation and content lists.

Because of the arguments in the previous two paragraphs, it's not feasible to add search functionality to the Workshop Materials project.

jmewes commented 3 years ago

Maybe it's a actually a good idea 🤔

jmewes commented 3 years ago

Here is a hack which may enable a search dialog:

https://github.com/experimental-software/workshop-materials/pull/14

It still requires a few hours work to make the layout and code structure nice.