Add search about fish-site HOT 5 CLOSED

👋 As always, @Haroenv got a point.

Happy to help on this @ridiculousfish

A preview:

You can try it out here

We do provide search analytics in order to enhance your doc if you want.

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/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />

<!-- at the end of the BODY -->
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
<script type="text/javascript"> docsearch({
  apiKey: 'ffed66937f1e00fb19bf61bc7845ab8d',
  indexName: 'fishshell',
  inputSelector: '### REPLACE ME ####',
  debug: false // Set debug to true if you want to inspect the dropdown
});
</script>

• Add a search input in your page if you don't have any yet. Then update the inputSelector value in JS snippet to a CSS selector that targets your search input field.
• Optionally customize the look and feel by following the DocSearch documentation
• You can also check your configuration in our GitHub repo.

Please open a pull request if want to leverage your configuration!

Feel free to get back to us if you have any issues or questions regarding the integration.

Have a nice day :)

from fish-site.

Sounds nifty! What's a good live example to try?

from fish-site.

https://reactjs.org

from fish-site.

https://docsearch-fishshell.netlify.com @ridiculousfish, we updated the demo, in case you're interested :)

from fish-site.

This is actually included in our new doc system based on sphinx, so it'll be in the 3.1 release.

from fish-site.