Skip to content

feat: add DocSearch as recommended by vuepress #91

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

Merged
merged 1 commit into from
Mar 26, 2020

Conversation

s-pace
Copy link

@s-pace s-pace commented Mar 26, 2020

👋 team,

I am working on DocSearch. We have an integration for Vuepress. We thought it is a shame you can not also used this search that you can find on vuejs for example.

This PR will add DocSearch to the documentation website. It will allow an user to have a learn-as-you-type experience by displaying results thanks to a dropdown in a live way.

Let me know if you need anything.

@dsevillamartin
Copy link
Member

Looks great. Thanks for the PR! 🙂

@dsevillamartin dsevillamartin merged commit e5daace into flarum:master Mar 26, 2020
@s-pace s-pace deleted the patch-1 branch March 26, 2020 15:14
@dsevillamartin
Copy link
Member

dsevillamartin commented Mar 26, 2020

Actually - looks like search results include the docs path in the search results, causing a chain of /docs/docs etc.

Is this because of an incorrect configuration in our part? The link points to the correct https://flarum.org/docs URL, but when clicking it it adds another /docs to the path.

Ignore me. The issue was fixed in a newer release of vuepress. Thanks for the PR :).

@franzliedke
Copy link
Contributor

@s-pace @datitisev Do we have to do anything to update the search index when we deploy the latest version?

@s-pace
Copy link
Author

s-pace commented Jun 3, 2020

You can wait for 24H or ping me. I have triggered the crawl manually. We are working on making it on demand

s-pace pushed a commit to algolia/docsearch-configs that referenced this pull request Jun 3, 2020
@franzliedke
Copy link
Contributor

Oh, great. 24 hours is perfectly fine for us, I would think.

Does the crawling happen on the Git repo, or on the version that is deployed on our site? (Right now, pushes to the master branch in flarum/docs do not trigger site rollouts.)

@s-pace
Copy link
Author

s-pace commented Jun 3, 2020

It only fetch data from the live website yes

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

Successfully merging this pull request may close these issues.

3 participants