p5.js-website
p5.js-website copied to clipboard
Add DocSearch
Hello Processing team,
Someone noticed that your documentation could take advantage of our DocSearch initiative. So, we went on trying to improve the search and came up with this PR. \o/
DocSearch is crawling the website every 24h, extracting content from every page. Then this content is indexed by Algolia and exposed to the user with a searchbox and its custom dropdown.
You might have already used DocSearch on some popular documentations like Bootstrap, Vue, jQuery, React, Jest, Gitlab, Brew, Heroku, Stripe ... So far, we are maintaining our crawler for 1500+ docs.
- DocSearch is fast, it handles typos and highlighting.
- Search results jump directly to the matching part of the page.
- Whenever your markup changes you can customize the configuration on DocSearch repository.
- You'll also have access to a dashboard of the most queried terms, as well as those that yields no results. We found it to be a very good way of knowing how to improve our documentation.
- DocSearch is and will remain FREE
Changes:
- load docsearch js and css from cdn
- configure and init docsearch
- add meta for language support
- styling
- clean previous search code
Screenshots of the change:
Hey there, I'm Alex, the whistleblower for the Docsearch team. I hope you don't mind. I thought it would be a delightful improvement over the google powered search, which breaks the design and experience of looking into the documentation.