chore(docs): use markdown syntax for external links - #4667
Open
thetaPC wants to merge 7 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
brandyscarney
requested changes
Aug 26, 2026
| ### The Alpha Problem | ||
|
|
||
| There is not yet full <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#Browser_compatibility" target="_blank">browser support</a> for alpha use of a hex color. The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#rgb()_and_rgba()" target="_blank">`rgba()`</a> function only accepts a value in `R, G, B, A` (Red, Green, Blue, Alpha) format. The following code shows examples of correct and incorrect values passed to `rgba()`. | ||
| There is not yet full [browser support](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#Browser_compatibility) for alpha use of a hex color. The [`rgba()`](<https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#rgb()_and_rgba()>) function only accepts a value in `R, G, B, A` (Red, Green, Blue, Alpha) format. The following code shows examples of correct and incorrect values passed to `rgba()`. |
Member
There was a problem hiding this comment.
Is there a reason the rgba link is enclosed in <>?
Contributor
Author
There was a problem hiding this comment.
Prettier applies when the URL contains parentheses (this one ends in #rgb()_and_rgba()).
| ### The Alpha Problem | ||
|
|
||
| There is not yet full <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#Browser_compatibility" target="_blank">browser support</a> for alpha use of a hex color. The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#rgb()_and_rgba()" target="_blank">`rgba()`</a> function only accepts a value in `R, G, B, A` (Red, Green, Blue, Alpha) format. The following code shows examples of correct and incorrect values passed to `rgba()`. | ||
| There is not yet full [browser support](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#Browser_compatibility) for alpha use of a hex color. The [`rgba()`](<https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#rgb()_and_rgba()>) function only accepts a value in `R, G, B, A` (Red, Green, Blue, Alpha) format. The following code shows examples of correct and incorrect values passed to `rgba()`. |
Member
There was a problem hiding this comment.
Is there a reason the rgba link is enclosed in <>?
Contributor
Author
There was a problem hiding this comment.
Prettier applies when the URL contains parentheses (this one ends in #rgb()_and_rgba()).
|
|
||
| ### CORS {/* #cors */} | ||
|
|
||
| [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross-Origin Resource Sharing) is a mechanism for servers to control client access to web assets. Refer to the [CORS FAQs](../troubleshooting/cors) for more information. |
Member
There was a problem hiding this comment.
Just FYI I did some research into inclusive language and Google's own inclusive documentation tips allow the word see:
Here is the direct link: https://developers.google.com/style/word-list#see
Contributor
Author
There was a problem hiding this comment.
That's awesome!! Thank you!
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
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
2 participants
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.
Issue URL: N/A
What is the current behavior?
External links are written two ways: mostly markdown, but 338 as raw
<a target="_blank">. 198 of those are missingrel="noopener noreferrer".The glossary is built from 41
<section>blocks with raw anchors, which prettier mangles into invalid HTML. So both glossaries sit in.prettierignore, andindex.mdneeds aprettier-ignore.Those anchors are HTML
idattributes, not heading IDs, so Docusaurus can't validate them. 195 broken anchor references went unchecked, including a[Babel](#babel)link with no Babel entry.What is the new behavior?
### Term {/* #id */}), all 41 IDs preservedLeft alone: 3 anchors that wrap markup, and 7 inside code fences.
Does this introduce a breaking change?
Other information
Readers see no difference. Docusaurus already adds
target="_blank" rel="noopener noreferrer"to external URLs, so markdown links render the same as the raw ones did.Wins:
rel="noopener noreferrer", closing awindow.openergap<h3>is invisible to it