docpad-archive / website

The DocPad Website. Replaced by GitBook: https://docpad.bevry.me
Other
22 stars 14 forks source link

Swap Google Search out for Algolia DocSearch #76

Closed balupton closed 5 years ago

balupton commented 5 years ago
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: '48c6883e944140f97e98a1e7682f30e5',
indexName: 'docpad',
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 (https://community.algolia.com/docsearch/documentation/)
- You can also check your configuration in our github repo (https://github.com/algolia/docsearch-configs/blob/master/configs/docpad.json).
balupton commented 5 years ago

Will be shutting down the docpad website and switching it to gitbook instead, making this issue deprecated.

Details here: https://discuss.bevry.me/t/migration-to-gitbook-for-all-documentation/270?u=balupton

s-pace commented 5 years ago

Hi, I am working on DocSearch.

Do you want us to remove this index?

balupton commented 5 years ago

Yes please.