Skip to content
This repository has been archived by the owner on Feb 9, 2022. It is now read-only.

Add a config for new Rudder docs based on Antora #523

Merged
merged 1 commit into from Aug 6, 2018

Conversation

amousset
Copy link
Contributor

@amousset amousset commented Aug 6, 2018

This is a new config for Rudder documentation (we already have https://github.com/algolia/docsearch-configs/blob/master/configs/rudder_project.json), for our new doc site based on Antora. This config is hence based on https://github.com/algolia/docsearch-configs/blob/master/configs/antora.json.
Note: I put 0 as conversation_id as I do not know what to put here.

This is a new config for Rudder (we already have https://github.com/algolia/docsearch-configs/blob/master/configs/rudder_project.json), for our new doc site based on Antora. This config is hence based on https://github.com/algolia/docsearch-configs/blob/master/configs/antora.json.
Note: I put 0 as `conversation_id` as I do not know what to put here.
@s-pace s-pace merged commit 72d438c into algolia:master Aug 6, 2018
@s-pace
Copy link
Contributor

s-pace commented Aug 6, 2018

  • 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: 'cd30a0d30ff5152bad8f0f74d6b73875', 
indexName: 'rudder', 
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.
  • Alexis has already an Algolia account. Analytics available from the Algolia dashboard by selecting the application DOCSEARCH (access granted)

@amousset
Copy link
Contributor Author

amousset commented Aug 6, 2018

Thanks, it works well!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants