feat: add search to website by tbouffard · Pull Request #853

feat: add search to website by tbouffard · Pull Request #853 · maxGraph/maxGraph

Walkthrough

This change adds the @easyops-cn/docusaurus-search-local plugin to the Docusaurus website configuration, enabling local search functionality. The plugin is included in the website's dependencies, configured with specific options, and grouped for automated dependency updates via Dependabot.

Changes

File(s)	Change Summary
.github/dependabot.yml	Added `@easyops-cn/docusaurus-search-local` to the "docusaurus" update group for npm dependencies.
packages/website/docusaurus.config.ts	Configured the `@easyops-cn/docusaurus-search-local` theme with options for local search support.
packages/website/package.json	Added `@easyops-cn/docusaurus-search-local` as a new dependency.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocusaurusWebsite
    participant LocalSearchPlugin

    User->>DocusaurusWebsite: Enters search term
    DocusaurusWebsite->>LocalSearchPlugin: Passes search query
    LocalSearchPlugin->>DocusaurusWebsite: Returns search results
    DocusaurusWebsite->>User: Displays results with highlighted terms

Assessment against linked issues

Objective	Addressed	Explanation
Add a built-in search engine to the website covering documentation and blog (#852)	✅
Use a local search plugin compatible with Docusaurus v3.x and React 19 (#852)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Possibly related PRs

ci: configure dependabot to update JavaScript dependencies #629: The main PR extends the existing dependabot configuration by adding a new package pattern to the "docusaurus" group, directly building upon the dependabot grouping setup introduced in the retrieved PR.

Suggested labels

chore

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-25T06_36_40_854Z-debug-0.log

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f620a17 and 57c9092.

📒 Files selected for processing (1)

packages/website/docusaurus.config.ts (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/website/docusaurus.config.ts

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.