legend
legend copied to clipboard
finos
Support search in documentation
Feature Request
Description of Problem:
@gs-bracej @beekemarie We should enable native Algolia search for the doc site, we might need to do some registration, but it's free for OSS project and it's very powerful, so why not?
I will come back to this when I have more time. But @maoo, we need to register with Algolia first. Check Docusaurus's doc: https://docusaurus.io/docs/en/search And for Algolia site registration - https://docsearch.algolia.com/apply/
This issue is stale because it has been open for 30 days with no activity. Please remove stale label or add any comment to keep this open. Otherwise this will be closed in 5 days.
This issue was closed because it has been inactive for 35 days. Please re-open if this issue is still relevant.
@maoo hey, can we resurrect this and apply for Algolia again? If we get the key, can you help us set it up as a secret or something? @xannem is interested in trying out upgrade to docasaurus@v2. Much appreciated!
admin api key is secret but the search-only api key is safe to share in repo :)
This issue is stale because it has been open for 30 days with no activity. Please remove stale label or add any comment to keep this open. Otherwise this will be closed in 5 days.
Hi @akphi I've applied for Algolia again. Will get back to you with the snippet you'll have to add to the docs website. Here is the public key 86ec4b2b02b99254ba236724fe4fef6b. I've added the private key as a secret under ALGOLIA_ADMIN_API_KEY
@akphi here are the snippets:
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>
JavaScript
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: X69JR631XX,
apiKey: b8ea4fa1535a60bc9385193ba58dcd69,
indexName: legend-finos,
container: '### REPLACE ME WITH A CONTAINER (e.g. div) ###'
debug: false // Set debug to true if you want to inspect the modal
});
</script>
I also forwarded you the email from Algolia that has a link to their docs.
Let me know if you need anything else.
@TheJuanAndOnly99 Thank you for following up 🙌 @xannem please try and apply this when you come back to this effort. Thanks!
This issue is stale because it has been open for 30 days with no activity. Please remove stale label or add any comment to keep this open. Otherwise this will be closed in 5 days.
This issue was closed because it has been inactive for 35 days. Please re-open if this issue is still relevant.