feat: use translate=no attribute in code sensitive renderings#2697
Open
displague wants to merge 1 commit intoRedocly:mainfrom
Open
feat: use translate=no attribute in code sensitive renderings#2697displague wants to merge 1 commit intoRedocly:mainfrom
displague wants to merge 1 commit intoRedocly:mainfrom
Conversation
displague
commented
Jun 5, 2025
Author
displague
left a comment
There was a problem hiding this comment.
This PR is in draft and not considered to be complete. I believe I've seen <div> used for some text elements in Redoc renderings. In the prompt for this change I hinted that likely candidates for change would be <span> elements.
I don't believe <code> needs to be decorated the same way, but we could easily add that if we can not assume translation services block those elements.
Signed-off-by: Marques Johansson <marques@displague.com>
Author
|
I see the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What/Why/How?
This VS Code Copilot created PR is a proof-of-concept of the
translate="no"feature described in the issue linked below. This is a light approach to enable tools like Google Translate (and others) to better handle Redoc rendered OpenAPI specs using a W3C standard HTML attribute.(Project owners: feel free to close this if you have a better sense of what changes are appropriate and it is faster to iterate on this idea without an outside collaborator.)
Prompt (~):
Reference
Fixes #2696
Tests
Using
npm startand reviewing the rendered spec (museum.yaml) for markup.Screenshots (optional)
Check yourself