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

feat:Chinese search is supported #2379

Closed
wants to merge 1 commit into from
Closed

Conversation

XingChenGod
Copy link

What:
This PR aims to add support for Chinese search functionality in ReDoc. Currently, ReDoc supports searching API documentation using English keywords, but this feature request proposes extending the search capability to include Chinese language support. With this enhancement, users will be able to search for API endpoints, methods, and descriptions using both English and Chinese keywords.

Why:
Adding Chinese search support is important to cater to a wider user base, especially in regions where Chinese is the primary language. By enabling users to search for API documentation using Chinese keywords, ReDoc becomes more accessible and user-friendly for Chinese-speaking developers. This enhancement aligns with the goal of making ReDoc a versatile and inclusive tool for API documentation.

How:
Currently, there are only Node.js and WebAssembly-based Chinese word segmentation libraries available on npm.
In order to support Chinese search. So you hid the English word segmentation functionality

Tests

Screenshots (optional)

issue:#2373 (comment)

Check yourself

  • [ yes ] Code is linted
  • [ yes ] Tested
  • [ yes ] All new/updated code is covered with tests

@XingChenGod XingChenGod requested a review from a team as a code owner August 9, 2023 08:11
@lornajane
Copy link
Contributor

Thank you so much for the pull request, and sorry for the slow response. We don't have good support for other character sets in Redoc at the moment, and it will be difficult for us to adopt and support this feature in the long term. Therefore, with apologies, I am closing this pull request.

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.

None yet

2 participants