-
Notifications
You must be signed in to change notification settings - Fork 246
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
[Bug] Refactor selective sanitization of > and < symbols in generated markdown descriptions #377
Conversation
Size Change: -30 B (0%) Total Size: 4.22 MB ℹ️ View Unchanged
|
Visit the preview URL for this PR (updated for commit 7034b1d): https://docusaurus-openapi-36b86--pr377-xpa0qkgz.web.app (expires Fri, 03 Feb 2023 21:13:39 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
Decided to refactor and simplify how |
Description
Some descriptions or code snippets include placeholders for user input or variables. For example:
Since docusaurus could potentially mistake these as HTML/JSX tags, we use a regex to selectively URL-encode these
<
or>
symbols, which could lead to rendering issues like this:This change attempts to selectively ignore placeholder/user input variables. The idea is that placeholders that begin with
<
are allowed as long as they are all caps, e.g.<VARIABLE>
.Motivation and Context
Placeholders can be useful for code blocks.
How Has This Been Tested?
Has not been thoroughly tested for regression bugs. We need to determine test plan.
Screenshots (if appropriate)
See deploy preview...will try to find and include other examples, like the Compute API.