refactor: Bump marked, move most HTML transforms into it #1205
Conversation
This file contains 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
rschristian
commented
Dec 7, 2024
Comment on lines
-10
to
-14
| <center> | ||
| <a href="https://saucelabs.com/u/preact"> | ||
| <img src="https://saucelabs.com/browser-matrix/preact.svg" alt="Browserlist"> | ||
| </a> | ||
| </center> |
There was a problem hiding this comment.
The saucelabs link is dead & has been for ages. Removed it
| <img src="/pwa-guide/timeline.jpg" alt="Eine DevTools-Zeitleisten-Trace der preactjs.com-Seite auf einem Nexus 5X"/> | ||
|  |
There was a problem hiding this comment.
Simply an unnecessary use of HTML when normal markdown would do & is preferable
| <img src="/home/metal.svg" alt="metal"> | ||
| <img src="/home/metal.svg" alt="metal" loading="lazy" decoding="async" width="54" height="54"> |
There was a problem hiding this comment.
decoding="async" is the only real addition here, lazy & the sizes have been added to the English doc ages ago but hasn't quite made it to all the translations. Figured I'd fix it now.
Comment on lines
-117
to
-122
| /* | ||
| * Many markdown formatters can generate the table of contents | ||
| * automatically. To skip a specific heading the use an html | ||
| * comment at the end of it. Example: | ||
| * | ||
| * ## Some random title <!-- omit in toc --> |
There was a problem hiding this comment.
We've never made use of this, and I don't imagine we will anytime soon
| @@ -1,10 +0,0 @@ | |||
| import marked from 'marked'; | |||
There was a problem hiding this comment.
Leftover, long-since unused.
marvinhagemeister
approved these changes
Dec 7, 2024
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.
Not quite as clean as I'd like but it's an improvement.
Nearly all HTML transforms (like adding
target="_blank"to external links or fragment links to headings) are now handled bymarkedat build time rather thanpreact-markupat runtime. Shouldn't be noticeable difference in terms of bundle or perf, but will be slightly better for the latter in theory.HTML in markdown is the one hair in the soup though, as
markedwill not handle it. We only make use of it on the home page really, not sure if we can refactor that to avoid this. As such, had to update some of the/index.mddocuments to adddecoding="async"to them, aspreact-markupno longer will, and we'll need to keep around the HTML parser-based highlighting for those code blocks/demos at the very bottom of the home page.