Add search to the docs - Githubissues

Haroenv commented 6 years ago

Algolia offers docsearch, which is free. Would be nice to have here

SachaG commented 6 years ago

Agreed! PR welcome ;)

Haroenv commented 6 years ago

Hi there,

Congratulations, your search is now ready! I've successfully configured the underlying crawler and it will now run every 24h.

You're now a few steps away from having it working on your website:

Copy the following CSS/JS snippets and add them to your page

<!-- at the end of the HEAD -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
<!-- at the end of the BODY -->
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript"> docsearch({
  apiKey: 'ab091fbd89cda3abd54a35c4441b3e9b',
  indexName: 'vulcanjs',
  inputSelector: '### REPLACE ME ####',
  debug: false // Set debug to true if you want to inspect the dropdown
});
</script>

Add a search input if you don't have any yet, and update the inputSelector value in the code snippet to a CSS selector that targets your input field.
Optionally customize the look and feel by following the DocSearch documentation (https://community.algolia.com/docsearch/documentation/)
You can also check your configuration in the github repo (https://github.com/algolia/docsearch-configs/blob/master/configs/vulcanjs.json). Feel free to open pull requests!

Feel free to get back to us if you have any issues or questions regarding the integration. We'd also be happy to get your feedback and thoughts about DocSearch - so we can continue to improve it.

Have a nice day :)

SachaG commented 6 years ago

That's awesome, thanks so much!

SachaG commented 6 years ago

Done :) http://docs.vulcanjs.org/

Haroenv commented 6 years ago

Love it! I'd personally give the search bar a higher opacity though, I couldn't see it at first glance

VulcanJS / vulcan-docs

Add search to the docs #45