Dev edition: add back jump-to search

[domenic]

Compare the new https://html.spec.whatwg.org/dev/ to the old https://developers.whatwg.org/. The latter has a nice search feature that we are missing.

See also #2565 about a different kind of search, full-text search.

Things to keep in mind:

• keyCode 191 does not always equal / benschwarz/developers.whatwg.org#55
• Keyboard cancellation of search box benschwarz/developers.whatwg.org#109

[j0lvera]

As discussed in IRC, before implementing the search feature, we need to generate the search_index.json file on the build process.

For this I've created a Python script that generates the same output as the old version:

• Python script
• new search_index.json
• old search_index.json

I'd like guidance on how to integrate it into the build process, the script has two dependencies, lxml and cssselect.

[j0lvera]

Maybe do this when running ./build.sh:

• Create a Python environment using virtualenv, virtualenv env
• Activate virtual environment, source env/bin/activate
• Install lxml and cssselect using pip, pip install lxml cssselect
• Run the Python script, python search_index.py
• Delete virtualenv's folders, rm -rf ./env

[domenic]

@thinkxl so awesome, thanks so much for your hard work!! Here are some of my thoughts:

• We should change "uri" to "url" in the JSON output while we're doing this update (reason)
• Will virtualenv be installed on most computers? Our current set of build system dependencies doesn't include it, and we're already talking about adding Python, which is a bit tricky.
• Speaking of which, will this require Python 2 or 3?
• Is there a way to keep the dependencies around after initial install, so that every build doesn't require re-downloading them from the internet? Ideally builds should be doable offline. Maybe just not deleting the virtualenv's folders? (We have a .cache directory available for storing this kind of thing.)
• We'll want to make sure that when the --no-update/-n flag is passed, this is skipped, so that people can get faster builds without it.
• Let's be sure to update the Dockerfile to include the appropriate Python dependency. I can help with testing and tweaking that if you can figure out what apt-get packages we want.

Probably the next step is to open a pull request on the html-build repository, which we can work together on.

[j0lvera]

We should change "uri" to "url" in the JSON output while we're doing this update (reason)

Great! I just did it that way because I wanted to match the old version. Done and getting a PR ready soon.

Will virtualenv be installed on most computers? Our current set of build system dependencies doesn't include it, and we're already talking about adding Python, which is a bit tricky.

Yes, virtualenv needs to be installed to avoid adding pip, lxml, cssselect to the build system dependencies. I hope that's not a problem? 😅

Speaking of which, will this require Python 2 or 3?

2.7 at least.

Is there a way to keep the dependencies around after initial install, so that every build doesn't require re-downloading them from the internet? Ideally builds should be doable offline. Maybe just not deleting the virtualenv's folders?

Yes, we can keep the virtualenv folder.

We can discuss the last two points with the pull request 😬.