Integrate DocSearch x Algolia in a DocFx site #9668

cdervout · 2024-01-31T08:47:14Z

cdervout
Jan 31, 2024

Hello,

I'd like to integrate Algolia search into a site generated by Docfx using the Modern template. I am asked to :

Copy this snippet at the end of the HTML <head> tag
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3"/></pre></li>

How update the <head> tag generation ?

Copy this snippet at the end of the HTML <body> tag

<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script>
<script type="text/javascript">
docsearch({
appId: xxxxxxx,
apiKey: xxxxxxx,
indexName: xxxxxxxxx,
insights: true, // Optional, automatically send insights when user interacts with search results
container: '### REPLACE ME WITH A CONTAINER (e.g. div) ###'
debug: false // Set debug to true if you want to inspect the modal
});
</script>

How update the <body> tag generation ?
How do you determine the container div to be defined in this setting?

Answered by filzrev

Jan 31, 2024

It's need to create custom template for DocSearch.

docfx modern template don't support partial template update.
It need to copy entire template layout file and need to modify contents.

Required steps

Create custom template that clone modern template's layout file.
filzrev/docfx.samples.docsearch@3ef095e
Add required DocSearch settings.
filzrev/docfx.samples.docsearch@70d204c

Sample DocSearch enabled site (Using Demo API key)
https://filzrev.github.io/docfx.samples.docsearch

View full answer

filzrev · 2024-01-31T09:32:05Z

filzrev
Jan 31, 2024

It's need to create custom template for DocSearch.

docfx modern template don't support partial template update.
It need to copy entire template layout file and need to modify contents.

Required steps

Create custom template that clone modern template's layout file.
filzrev/docfx.samples.docsearch@3ef095e
Add required DocSearch settings.
filzrev/docfx.samples.docsearch@70d204c

Sample DocSearch enabled site (Using Demo API key)
https://filzrev.github.io/docfx.samples.docsearch

0 replies

cdervout · 2024-02-01T08:39:44Z

cdervout
Feb 1, 2024
Author

That's what I was afraid of. Thanks for the answer. I've got everything I need to move forward.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integrate DocSearch x Algolia in a DocFx site #9668

{{title}}

Replies: 2 comments

{{title}}

{{title}}

Select a reply

Integrate DocSearch x Algolia in a DocFx site #9668

cdervout Jan 31, 2024

Replies: 2 comments

filzrev Jan 31, 2024

cdervout Feb 1, 2024 Author

cdervout
Jan 31, 2024

filzrev
Jan 31, 2024

cdervout
Feb 1, 2024
Author