New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Replace renderers
w/ components
, remove HTML parser from core
#563
Conversation
* Replace `renderers` w/ `components` * Replace `allowNode` w/ `allowElement`, which is now given a hast element (as the first parameter) * Replace `allowedTypes` w/ `allowedElements` * Replace `disallowedTypes` w/ `disallowedElements` * Change signature of `linkTarget` and `transformLinkUri`, which are now given hast children (as the second parameter) * Change signature of `transformImageUri`, which is now given the `alt` string as the second parameter (instead of the fourth) * Replace `plugins` w/ `remarkPlugins` (backwards compatible change) * Add `rehypePlugins` * Change `includeNodeIndex` to `includeElementIndex`: it still sets an `index`, but that value now represents the number of preceding elements, it also sets a `siblingCount` (instead of `parentChildCount`) with the number of sibling elements in the parent * The `columnAlignment` prop is no longer given to table elements: it’s available as `style` on `th` and `td` elements instead * The `spread` prop is no longer given to list elements: it’s already handled
* If you want HTML, add [`rehype-raw`](https://github.com/rehypejs/rehype-raw) to `rehypePlugins` and it’ll work without bugs! * Remove `allowDangerousHtml` (previously called `escapeHtml`) option: pass `rehype-raw` to allow HTML instead * Remove `with-html.js`, `plugins/html-parser.js` entries from library * Remove naïve HTML parser too: either use `rehype-raw` to properly support HTML, or don’t allow it at all
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @wooorm!
Co-authored-by: Christian Murphy <christian.murphy.42@gmail.com>
This comment has been minimized.
This comment has been minimized.
Hi, Previously renderers supported |
Something like |
renderers
w/components
allowNode
w/allowElement
, which is now given a hast element (as the first parameter)allowedTypes
w/allowedElements
disallowedTypes
w/disallowedElements
linkTarget
andtransformLinkUri
, which are now given hast children (as the second parameter)transformImageUri
, which is now given thealt
string as the second parameter (instead of the fourth)plugins
w/remarkPlugins
(backwards compatible change)rehypePlugins
includeNodeIndex
toincludeElementIndex
: it still sets anindex
, but that value now represents the number of preceding elements, it also sets asiblingCount
(instead ofparentChildCount
) with the number of sibling elements in the parentcolumnAlignment
prop is no longer given to table elements: it’s available asstyle
onth
andtd
elements insteadspread
prop is no longer given to list elements: it’s already handledRemove buggy HTML parsers from core
rehype-raw
torehypePlugins
and it’ll work without bugs!allowDangerousHtml
(previously calledescapeHtml
) option: passrehype-raw
to allow HTML insteadwith-html.js
,plugins/html-parser.js
entries from libraryrehype-raw
to properly support HTML, or don’t allow it at allCloses GH-549.
The following issues are solved as rehype is now available:
Closes GH-522.
Closes GH-465.
Closes GH-427.
Closes GH-384.
Closes GH-356.
The following issues are solved as a proper HTML parser (
rehype-raw
) is now available:Closes GH-562.
Closes GH-460.
Closes GH-454.
Closes GH-452.
Closes GH-433.
Closes GH-386.
Closes GH-385.
Closes GH-345.
Closes GH-320.
Closes GH-302.
Closes GH-267.
Closes GH-259.
The following issues are solved as docs are improved:
Closes GH-251.