[Docs Site] Use Tippy.js for footnotes #17357
Merged
Conversation
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
KianNH
requested review from
a team,
GregBrimble,
WalshyDev,
haleycode,
kristianfreeman,
marciocloudflare,
maxvp and
pedrosousa
as code owners
github-actions
bot
assigned
GregBrimble,
haleycode,
kristianfreeman,
marciocloudflare,
maxvp,
pedrosousa and
WalshyDev
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| mermaid.initialize({ startOnLoad: false, theme }); | ||
| await mermaid | ||
| .render(`mermaid-${crypto.randomUUID()}`, def) | ||
| .then(({ svg }) => (diagram.innerHTML = svg)); |
Check warning
Code scanning / CodeQL
DOM text reinterpreted as HTML
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix
AI about 1 year ago
To fix the problem, we need to ensure that the content being inserted into innerHTML is properly sanitized. Since the mermaid.render function is used to generate the SVG content, we should ensure that this content is safe. If mermaid does not guarantee the safety of its output, we should sanitize the SVG content before inserting it into the DOM.
The best way to fix this without changing existing functionality is to use a library like DOMPurify to sanitize the SVG content before setting it as innerHTML. This ensures that any potentially harmful content is removed.
Suggested changeset
2
src/scripts/mermaid.ts
| @@ -1,2 +1,3 @@ | ||
| import mermaid from "mermaid"; | ||
| import DOMPurify from "dompurify"; | ||
|
|
||
| @@ -22,3 +23,3 @@ | ||
| .render(`mermaid-${crypto.randomUUID()}`, def) | ||
| .then(({ svg }) => (diagram.innerHTML = svg)); | ||
| .then(({ svg }) => (diagram.innerHTML = DOMPurify.sanitize(svg))); | ||
|
|
package.json
Outside changed files
| @@ -85,3 +85,6 @@ | ||
| "node": "22.8.0" | ||
| } | ||
| }, | ||
| "dependencies": { | ||
| "dompurify": "^3.1.7" | ||
| } | ||
| } |
This fix introduces these dependencies
| Package | Version | Security advisories |
| dompurify (npm) | 3.1.7 | None |
Copilot is powered by AI and may make mistakes. Always verify output.
Member
Author
|
Closes #16250 |
Deploying cloudflare-docs with
|
| Latest commit: |
1e454fd
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://038f916d.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://kian-pcx-13959.cloudflare-docs-7ou.pages.dev |
Contributor
|
Files with changes (up to 15)
|
marciocloudflare
approved these changes
Oct 9, 2024
elithrar
pushed a commit
that referenced
this pull request
Oct 15, 2024
* [Docs Site] Use Tippy.js for footnotes * tabindex/hover cutoff fixes * update style guide link to lib * new fnref styling
maheshwarip
pushed a commit
that referenced
this pull request
Dec 2, 2024
* [Docs Site] Use Tippy.js for footnotes * tabindex/hover cutoff fixes * update style guide link to lib * new fnref styling
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 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.
Summary
Use Tippy.js for footnotes
Screenshots (optional)
Before:
After:
