Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to use the search function, there is no documentation yet #1078

Closed
3 tasks done
sishen654 opened this issue Jul 28, 2022 · 8 comments
Closed
3 tasks done

How to use the search function, there is no documentation yet #1078

sishen654 opened this issue Jul 28, 2022 · 8 comments
Labels
docs Improvements or additions to documentation question This is a question rather than an issue or pull request

Comments

@sishen654
Copy link

Describe the bug

none

Reproduction

none

Expected behavior

none

System Info

none

Additional context

No response

Validations

  • Follow our Code of Conduct
  • Read the docs.
  • Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
@sishen654 sishen654 added the bug: pending triage Maybe a bug, waiting for confirmation label Jul 28, 2022
@brc-dd
Copy link
Member

brc-dd commented Jul 28, 2022

You need to apply for Algolia Docsearch, if it gets approved you need to configure crawler etc. there and add your Algolia config in .vitepress/config.ts like this:

algolia: {
appId: '8J64VVRP8K',
apiKey: 'a18e2f4cc5665f6602c5631fd868adfd',
indexName: 'vitepress'
},

@brc-dd brc-dd added docs Improvements or additions to documentation question This is a question rather than an issue or pull request and removed bug: pending triage Maybe a bug, waiting for confirmation labels Jul 28, 2022
@sishen654
Copy link
Author

thank you!I'll give it a try.

@Szymon-dziewonski
Copy link

@brc-dd could you maybe help out how to set up crawler? i cant manage to run it to have index for algolia

@sishen654
Copy link
Author

@brc-dd could you maybe help out how to set up crawler? i cant manage to run it to have index for algolia

I'm sorry I don't have time to do this crawler yet, you can look at the user manual on the official website or some libraries that use crawler, such as Vite or Vue3

@Szymon-dziewonski
Copy link

@sishen654 maybe Im wrong but I read and heard from my friend who did it, crawler is available for some pro acc, for open source you need to file for it via this form https://www.algolia.com/for-open-source/ then they set up crawler for your page, I did it, when I will have some update will write here :)

@brc-dd
Copy link
Member

brc-dd commented Sep 12, 2022

@Szymon-dziewonski Yeah, when your docsearch account is approved, you'll get access to an admin console where you can configure the crawler. These are their recommended templates: https://docsearch.algolia.com/docs/templates/ . You can customize them accordingly if you're getting some weird results. (I'm not managing VitePress' crawler, so I can't tell for sure what is the exact config we are using.)

@e3d
Copy link

e3d commented Sep 19, 2022

Search is essential for vitepress. Not every projects get supported by agolia docsearch. It would be great for vitepress to have its own.

This was referenced Oct 11, 2022
@isuke01
Copy link

isuke01 commented Nov 22, 2022

Yes What about the private repos? I could use standard algolia, just Have no idea how to setup crawler/push data from VP?

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Improvements or additions to documentation question This is a question rather than an issue or pull request
Projects
None yet
Development

No branches or pull requests

5 participants