Move to micromark #5330
Merged
Move to micromark #5330
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
compulim
requested review from
srinaath,
tdurnford and
beyackle2
as code owners
OEvgeny
reviewed
Oct 25, 2024
There was a problem hiding this comment.
I don't see any difference, I assume our snapshot matcher knows better
OEvgeny
reviewed
Oct 25, 2024
| }, | ||
| logLevel: 'info', | ||
| // Generate stats.json. | ||
| metafile: true, | ||
| // Minified file is smaller and load faster from GitHub Codespaces. | ||
| minify: true, | ||
| outdir: resolveFromProjectRoot('./dist'), | ||
| outdir: resolveFromProjectRoot('./dist/dev'), | ||
| plugins: [isomorphicReactResolvePlugin], |
OEvgeny
reviewed
Oct 25, 2024
OEvgeny
reviewed
Oct 25, 2024
| @@ -145,7 +140,14 @@ export default function render( | |||
| return decoration; | |||
| }; | |||
|
|
|||
| const htmlAfterMarkdown = ariaLabelPost(new MarkdownIt(MARKDOWN_IT_INIT).use(ariaLabel).render(markdown)); | |||
| const htmlAfterMarkdown = micromark(markdown, { | |||
| allowDangerousHtml: markdownRenderHTML ?? true, | |||
There was a problem hiding this comment.
I assume it is true by default as we still have sanitize after it.
OEvgeny
approved these changes
Oct 25, 2024
11 tasks
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.
Changelog Entry
Breaking changes
micromarkfor rendering Markdown, instead ofmarkdown-itChanged
micromarkfor rendering Markdown, instead ofmarkdown-it, in PR #5330, by @compulimDescription
Moving from
markdown-ittomicromarkso we can support MathML and TeX (viamicromark-extension-mathandkatex) in short future.We are still using
markdown-itfor internal localization and will evaluate if we should move to ICU/MessageFormat ormicromark.Design
One-pager
'would become´in some cases,"would become‶and″, and...would become…www.bing.comandhttps://bing.cominto linksbing.com<iframe>into<iframe>aria-labelattribute via{aria-label=""}<a aria-label="">directly<p>Corner cases
Oneliner:
micromarkwith "allow dangerous HTML" requires a separate sanitization process to make sure HTML code rendered are safe to use.[Link](javascript:alert(1))<a href="javascript:alert(1)">Link</a>[Link](javascript:alert(1))(as text)<a href="">Link</a>(withoutallowDangerousProtocol)<a href="">Link</a>(withoutallowDangerousProtocol)<iframe>ABC</iframe><iframe>ABC</iframe><iframe>ABC</iframe><iframe>ABC</iframe><iframe>ABC</iframe><script>alert(0)</script><script>alert(0)</script><script>alert(0)</script><script>alert(0)</script><script>alert(0)</script><img onerror="javascript:alert(0)" /><img onerror="javascript:alert(0)" /><img onerror="javascript:alert(0)" /><img onerror="javascript:alert(0)" /><img onerror="javascript:alert(0)" />The content of
<iframe>tag is treated similar to CDATA. When usingmarkdown-it,<iframe>abc<b>def</b>xyz</iframe>will become<iframe>abc<b>def</b>xyz</iframe>, where<b>become<b>.This caused slight deviation when using GFM tagfilter extension where
<iframe>will turn into<iframe>. The content of<iframe>would not processed as CDATA but as-is.Thus, using
micromark-extension-gfm, the<iframe>abc<b>def</b>xyz</iframe>would become<iframe>abc<b>def</b>xyz</iframe>and "def" will be bold.Allowing dangerous protocol
micromarkdefault set of URL protocol is limited to a handful.As we are always do HTML sanitization, with
micromark, we should setallowDangerousProtocol: trueand let all protocol to fellthrough. So we only need to configure one rule for sanitization. Also, the protocol selection for links inmicromarkis limited and it don't allow URL handlers and links likecite:1.Later on down the pipe, the final step is sanitizer and it will remove "javascript:" properly.
Furthermore in our better link mod, all disallowed schemes will be turned into
<button value="javascript:">, which is mostly harmless.To enable sanitizing "javascript:" in links, we are skipping better link mod for "javascript:" protocol, so it continue to be
<a href="javascript:">and will be stripped by the final sanitizer.Injecting
aria-labelAs we introduced HTML-in-Markdown support recently, we encourage web devs to use HTML instead of
markdown-it-attrs.markdown-it[Link](https://bing.com/){aria-label="Bing homepage"}micromark<a aria-label="Bing homepage" href="https://bing.com/">Link</a>Auto-link
markdown-itturnwww.bing.com,bing.com, andhttps://bing.cominto a link.micromark-extension-gfm-autolink-literalwill ignorebing.com. Instead ofbing.com, bot author should usehttps://bing.cominstead.Smart quote
"Typographer" plugin, or "smart quote" was not introduced in
micromarkas it may cause issues with localization. For example,'would become´in some cases,"would become‶and″, and...would become….Math/TeX support
TODO: We are evaluating
micromark-extension-math, which use KaTeX. However, it is a huge dependency as it also include fonts, we are looking for ways to adopt it.Disabling HTML
Note: CommonMark spec did not specify how HTML code should look when HTML is disabled.
Given
<abc>as input Markdown text.markdown-itmicromark<abc><abc><p><abc></p><abc>Given
<abc>123</abc>as input Markdown text.markdown-itmicromark<abc>123</abc><abc>123</abc><p><abc>123</abc></p><p><abc>123</abc></p>Given
<a href="https://bing.com">.markdown-it:<a href="<a href="https://bing.com">https://bing.com</a>">https://bing.commicromark:<a href="https://bing.com">Bing.com</a>https://bing.comSpecific Changes
renderMarkdownto usemicromarkinstead ofmarkdown-itmarkdown-itfrombundle, we still use it inapinpm start, which was broken from PR Build: add entry points without top level side-effects #5329.CHANGELOG.mdI have updated documentationReview Checklist
Accessibility reviewed (tab order, content readability, alt text, color contrast)Browser and platform compatibilities reviewedCSS styles reviewed (minimal rules, noz-index)Documents reviewed (docs, samples, live demo)Internationalization reviewed (strings, unit formatting)package.jsonandpackage-lock.jsonreviewedSecurity reviewed (no data URIs, check for nonce leak)