fix(deps): update dependency react-markdown to v10 #3533
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.
This PR contains the following updates:
^5.0.3->^10.0.0Release Notes
remarkjs/react-markdown (react-markdown)
v10.1.0Compare Source
Add
939c667Addfallbackprop toMarkdownHooksby @remcohaszing in #897
Fix
a40ae2eFix race condition inMarkdownHooksby @remcohaszing in #896
Full Changelog: remarkjs/react-markdown@10.0.1...10.1.0
v10.0.1Compare Source
7c17edeFix TypeScript performance around componentsby @remcohaszing in #893
Full Changelog: remarkjs/react-markdown@10.0.0...10.0.1
v10.0.0Compare Source
aaaa40bRemove support for
classNamepropmigrate: see “Remove
className” belowRemove
classNameThe
classNameprop was removed.If you want to add classes to some element that wraps the markdown
you can explicitly write that element and add the class to it.
You can then choose yourself which tag name to use and whether to add other
props.
Before:
After:
v9.1.0Compare Source
6ce120eAdd support for async plugins
v9.0.3Compare Source
(same as 9.0.2 but now with d.ts files)
v9.0.2Compare Source
b151a90Fix types for React 19
6962af7Add declaration maps
aa5933bRefactor to use
@importto import typesv9.0.1Compare Source
d8e3787Fix double encoding in new url transform
v9.0.0Compare Source
b67d714Change to require Node.js 16
migrate: update too
ec2b134Change to require React 18
migrate: update too
bf5824fChange to use
exportsmigrate: don’t use private APIs
c383a45Update
@types/hast, utilities, plugins, etcmigrate: update too
eca5e6b08ead9eReplace
transformImageUri,transformLinkUriw/urlTransformmigrate: see “Add
urlTransform” belowde29396Remove
linkTargetoptionmigrate: see “Remove
linkTarget” below4346276Remove support for passing custom props to components
migrate: see “Remove
includeElementIndex”, “RemoverawSourcePos”,“Remove
sourcePos”, “Remove extra props passed to certain components”below
c0dfbd6Remove UMD bundle from package
migrate: use
esm.shor a CDN or soe12b5e9Remove
prop-typesmigrate: use TypeScript
4eb7aa0Change to throw errors for removed props
migrate: don’t pass options that don’t do things
8aabf74Change to improve error messages
migrate: expect better messages
Add
urlTransformThe
transformImageUriandtransformLinkUriwere removed.Having two functions is a bit much, particularly because there are more URLs
you might want to change (or which might be unsafe so we make them safe).
And their name and APIs were a bit weird.
You can use the new
urlTransformprop instead to change all your URLs.Remove
linkTargetThe
linkTargetoption was removed; you should likely not set targets.If you want to, use
rehype-external-links.Remove
includeElementIndexThe
includeElementIndexoption was removed, soindexis never passed tocomponents.
Write a plugin to pass
index:Show example of plugin
Remove
rawSourcePosThe
rawSourcePosoption was removed, sosourcePosis never passed tocomponents.
All components are passed
node, so you can getnode.positionfrom them.Remove
sourcePosThe
sourcePosoption was removed, sodata-sourceposis never passed toelements.
Write a plugin to pass
index:Show example of plugin
Remove extra props passed to certain components
When overwriting components, these props are no longer passed:
inlineoncode— create a plugin or use
prefor the blocklevelonh1,h2,h3,h4,h5,h6— check
node.tagNameinsteadcheckedonli— check
task-list-itemclass or checkprops.childrenindexonli— create a plugin
orderedonli— create a plugin or check the parent
depthonol,ul— create a plugin
orderedonol,ul— check
node.tagNameinsteadisHeaderontd,th— check
node.tagNameinsteadisHeaderontr— create a plugin or check children
v8.0.7Compare Source
c289176Fix performance for keys
by @wooorm
in #738
9034dbdFix types in syntax highlight example
by @dlqqq
in #736
Full Changelog: remarkjs/react-markdown@8.0.6...8.0.7
v8.0.6Compare Source
c289176Fix performance for keys
by @wooorm
in #738
9034dbdFix types in syntax highlight example
by @dlqqq
in #736
Full Changelog: remarkjs/react-markdown@8.0.6...8.0.7
v8.0.5Compare Source
d640d40Update to use
node16module resolution intsconfig.jsonby @ChristianMurphy
in #723
402fea3Fix typo in
pluginsdeprecation messageby @marc2332
in #719
4f98f73Remove deprecated and unneeded
defaultPropsby @Lepozepo
in #718
v8.0.4Compare Source
9b20440Fix type of
td,thpropsby @lucasassisrosa
in #714
cfe075bAdd clarification of
altonimgin docsby @cballenar
in #692
v8.0.3Compare Source
a2fb833Fix prop types of plugins
by @starpit
in #683
v8.0.2Compare Source
2712227Update
react-is704c3c6Fix TypeScript bug by adding workaround
by @Methuselah96
in #676
v8.0.1Compare Source
c23ecf6Add missing dependency for types
by @Methuselah96
in #675
v8.0.0Compare Source
cd845c9Remove deprecated
pluginsoption(migrate by renaming it to
remarkPlugins)36e4916Update
remark-rehype,add support for passing it options
by @peolic
in #669
(migrate by removing
remark-footnotesand updatingremark-gfmif youwere using them, otherwise you shouldn’t notice this)
v7.1.2Compare Source
656a4faFix
refin typesby @ChristianMurphy
in #668
v7.1.1Compare Source
4185f06Add improved docs
by @wooorm
in #657
v7.1.0Compare Source
7b8a829Add support for
SpecialComponentsto be anyComponentTypeby @Methuselah96
in #640
a7c26fcRemove warning on whitespace in tables
v7.0.1Compare Source
ec387c2Add improved type for
linkTargetas string5af6bc7Fix to correctly compile intrinsic types
v7.0.0Compare Source
Welcome to version 7.
This a major release and therefore contains breaking changes.
Breaking changes
01b11fec613efda1e1c3faeee9acUse ESM
(please read this)
3dffd6aUpdate dependencies
(upgrade all your plugins and this should go fine)
Internals
8b5481cfb1b512144af79Replace
jestwithuvu8c572dfReplace
rollupwithesbuild8737eac28d4c75b2dd046Refactor code-style
v6.0.3Compare Source
13367edFix types to include each element w/ its properties
0a1931aFix to add min version of
property-informationv6.0.2Compare Source
cefc02dAdd string type for
classNames6355e45Fix to pass
vfileto plugins5cf6e1bFix to add warning when non-strings are given as
childrenv6.0.1Compare Source
2e956beFix whitespace in table elements
d36048aAdd architecture section to readme
v6.0.0Compare Source
Welcome to version 6.
This a major release and therefore contains breaking changes.
Change
rendererstocomponentsreact-markdownused to let you define components for markdown constructs(
link,delete,break, etc).This proved complex as users didn’t know about those names or markdown
peculiarities (such as that there are fully formed links and link references).
See GH-549 for more
on why this changed.
See Appendix B: Components in
readme.mdfor more on components.
Show example of needed change
Before (broken):
Now (fixed):
Show conversion table
renderers)components)blockquoteblockquotebreakbrcode,inlineCodecode,pre*definitiondeletedel‡emphasisemheadingh1,h2,h3,h4,h5,h6§html,parsedHtml,virtualHtmlimage,imageReferenceimg†link,linkReferencea†listol,ul¶listItemliparagraphprootstrongstrongtabletable‡tableHeadthead‡tableBodytbody‡tableRowtr‡tableCelltd,th‡textthematicBreakhrinlineprop.
Block code is also wrapped in a
pre[text](url)) and reference ([text][id]) style links andimages (and their definitions) are now resolved and treated the same
remark-gfmlevelprop
rehype-raw(see below), components for those elementscan also be used (for example,
abbrfor<abbr title="HyperText Markup Language">HTML</abbr>)orderedprop
ReactMarkdownin a component insteadAdd
rehypePluginsWe’ve added another plugin system:
rehype.
It’s similar to remark (what we’re using for markdown) but for HTML.
There are many rehype plugins.
Some examples are
@mapbox/rehype-prism(syntax highlighting with Prism),
rehype-katex(rendering math with KaTeX), or
rehype-autolink-headings(adding links to headings).
See List of plugins
for more plugins.
Show example of feature
Remove buggy HTML in markdown parser
In a lot of cases, you should not use HTML in markdown: it’s most always unsafe.
And it defeats much of the purpose of this project (not relying on
dangerouslySetInnerHTML).react-markdownused to have an opt-in HTML parser with a bunch of bugs.As we now support rehype plugins, we can defer that work to a rehype plugin.
To support HTML in markdown with
react-markdown, userehype-raw.The
astPluginsandallowDangerousHtml(previously calledescapeHtml) propsare no longer needed and were removed.
When using
rehype-raw, you should probably userehype-sanitizetoo.
Show example of needed change
Before (broken):
Now (fixed):
Change
sourcetochildrenInstead of passing a
sourcepasschildreninstead:Show example of needed change
Before (broken):
Now (fixed):
Or (also fixed):
Replace
allowNode,allowedTypes, anddisallowedTypesSimilar to the
rendererstocomponentschange, the filtering optionsalso changed from being based on markdown names towards being based on HTML
names:
allowNodetoallowElement,allowedTypestoallowedElements, anddisallowedTypestodisallowedElements.Show example of needed change
Before (broken):
Now (fixed):
Before (broken):
Now (fixed):
Change
includeNodeIndextoincludeElementIndexSimilar to the
rendererstocomponentschange, this option to pass more infoto components also changed from being based on markdown to being based on HTML.
Show example of needed change
Before (broken):
Now (fixed):
Change signature of
transformLinkUri,linkTargetThe second parameter of these functions (to rewrite
hrefonaor to definetargetona) are now hast (HTML AST)instead of mdast (markdown AST).
Change signature of
transformImageUriThe second parameter of this function was always
undefinedand the fourth wasthe
alt(string) on the image.The second parameter is now that
alt.Remove support for React 15, IE11
We now use ES2015 (such as
Object.assign) and removed certain hacks to workwith React 15 and older.
Configuration
📅 Schedule: Branch creation - "every weekend" in timezone US/Eastern, Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.