🔍 Improving search on docs with Algolia's DocSearch

[Shipow]

Hello Prism team,

I've 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 demo:
💖Try out the search here 💖 (we've added docsearch.js to a mirror of your docs).

Algolia's DocSearch is crawling the website every 24h, extracting content from every page. Then this content is made searchable by Algolia's API and exposed to the user with a searchbox and its custom dropdown.

You might have already used DocSearch on some popular docs like Bootstrap, Vue, jQuery, React, Jest, Gitlab, Brew, Heroku, Invision, Stripe, Algolia, ...
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 (provided by Algolia).

Are you interested? 👍 👎


Ping @Shipow or @s-pace

[pascalduez]

Hello Prism team,

Hello [teamName] team,

🍝 😆

[Shipow]

${project.name} :p
the message looks a bit like an ad in its current shape. But still we hope the value is there <3

[pascalduez]

@Shipow the thing is we are not on the Prism organisation/repo here, but SassDoc.

Do you meant to ask whether we would be interested to use DocSearch for the sassdoc.com website?

[s-pace]

Here is a demo search on prismjs https://docsearch-prismjs.netlify.com/ @pascalduez
If you like this UX, we would be happy to feature your website. We can even provide you a friendly PR

[pascalduez]

I would personally find it useful.
I like the way it is integrated (simple and themed) on the Flow type docs for instance.

WDYT @hugogiraudel ?

Just to be clear, we are talking about the sassdoc.com website, which repository is SassDoc/sassdoc.github.io, right?

[s-pace]

@pascalduez Yep!