Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs(docs): setup docs search #1439

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Oct 18, 2022
Merged

docs(docs): setup docs search #1439

merged 1 commit into from
Oct 18, 2022

Conversation

michaelbe812
Copy link
Contributor

This PR will close #1433

I setup search using docusaurus-search-local.

To test it locally you will need to

é voilá:
image

In the documentation of the search-plugin there's also an option mentioned on how to have the search available in dev mode (without serving the build files from a web server) but at least i could not make it work with the nx setup.

Hint: if you are not serving the build docs from a web server and instead run the project in dev mode with nx serve docs you will get a warning when using the search bar:

image

@nx-cloud
Copy link

nx-cloud bot commented Oct 14, 2022 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 704cc06. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 4 targets

Sent with 💌 from NxCloud.

@LayZeeDK LayZeeDK self-requested a review October 17, 2022 14:38
LayZeeDK
LayZeeDK requested changes Oct 17, 2022
View reviewed changes
Copy link
Member

@LayZeeDK LayZeeDK left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @mikelgo! 🙌 This is awesome!

LayZeeDK
LayZeeDK requested changes Oct 17, 2022
View reviewed changes
@LayZeeDK
Copy link
Member

LayZeeDK commented Oct 17, 2022 •
edited
Loading

@mikelgo
We have the serve-static target for the docs project which calls docusaurus serve behind the scenes. Local search works when using nx serve-static docs 👍

LayZeeDK
LayZeeDK requested changes Oct 17, 2022
View reviewed changes
@michaelbe812
Copy link
Contributor Author

@mikelgo We have the serve-static target for the docs project which calls docusaurus serve behind the scenes. Local search works when using nx serve-static docs 👍

Great, thanks for pointing that out 👍

@michaelbe812 michaelbe812 requested a review from LayZeeDK October 18, 2022 04:52
@michaelbe812
Copy link
Contributor Author

michaelbe812 commented Oct 18, 2022 •
edited
Loading

@LayZeeDK Thanks for your review, I resolved all the points.

...and hopefully did the rebase correctly which I screwed up at first 😅

LayZeeDK
LayZeeDK approved these changes Oct 18, 2022
View reviewed changes
Copy link
Member

@LayZeeDK LayZeeDK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @mikelgo. This is a big help to the RxAngular team and the rest of the RxAngular community!

@michaelbe812
Copy link
Contributor Author

Thanks for your kind words @LayZeeDK, really appreciate it.
I hope I can provide even more helpful things in the future :-)

@LayZeeDK LayZeeDK merged commit b0630f6 into rx-angular:main Oct 18, 2022
@LayZeeDK LayZeeDK mentioned this pull request Nov 6, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@LayZeeDK LayZeeDK LayZeeDK approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: add search support
2 participants
@michaelbe812 @LayZeeDK