Skip to content

v2.0.0

Compare
Choose a tag to compare
@ChristianMurphy ChristianMurphy released this 12 Dec 01:10
· 57 commits to main since this release
v2.0.0
ec0e78b

react-markdown has a new name (generously donated by @AaronCCWong, thank you!), a new version of remark, and new maintainers (@remarkjs)!

For users of react-remark v1

This component used to be based on remarkable it is now based on remark.
If you are interested in migrating

<ReactRemark source={'# This is markdown!'}>

would become

<ReactRemark>{`# This is markdown!`}</ReactRemark>

in the new release.

For users of @christianmurphy/react-remark

The new npm package name is react-remark the version jumped from 0.3.1 to 2.0.0, due to a previous remarkable based version released as version 1.

⚠️ Breaking Change ⚠️ remark has updated to version 13 https://github.com/remarkjs/remark/releases/tag/13.0.0
This upgrade means that by default only CommonMark is supported out of the box, if you need GitHub Flavored Markdown features, like tables and autolinking, please add remark-gfm as a plugin.
For example:

import { Remark } from 'react-remark';
import remarkGfm from 'remark-gfm';

// ...
<Remark remarkPlugins={[remarkGfm]}>{content}</Remark>

This also means all remark plugins must be updated to versions that support remark 13.