react-markdown - npm Package Versions

9.0.0 - 2023-09-27

• b67d714 Change to require Node.js 16
  migrate: update too
• ec2b134 Change to require React 18
  migrate: update too
• bf5824f Change to use exports
  migrate: don’t use private APIs
• c383a45 Update @types/hast, utilities, plugins, etc
  migrate: update too
• eca5e6b 08ead9e Replace transformImageUri, transformLinkUri w/ urlTransform
  migrate: see “Add urlTransform” below
• de29396 Remove linkTarget option
  migrate: see “Remove linkTarget” below
• 4346276 Remove support for passing custom props to components
  migrate: see “Remove includeElementIndex”, “Remove rawSourcePos”, “Remove sourcePos”, “Remove extra props passed to certain components” below
• c0dfbd6 Remove UMD bundle from package
  migrate: use esm.sh or a CDN or so
• e12b5e9 Remove prop-types
  migrate: use TypeScript
• 4eb7aa0 Change to throw errors for removed props
  migrate: don’t pass options that don’t do things
• 8aabf74 Change to improve error messages
  migrate: expect better messages

Add urlTransform

The transformImageUri and transformLinkUri were 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 urlTransform prop instead to change all your URLs.

Remove linkTarget

The linkTarget option was removed; you should likely not set targets. If you want to, use rehype-external-links.

Remove includeElementIndex

The includeElementIndex option was removed, so index is never passed to components. Write a plugin to pass index:

import {visit} from 'unist-util-visit'

function rehypePluginAddingIndex() {
  /**
   * @param {import('hast').Root} tree
   * @returns {undefined}
   */
  return function (tree) {
    visit(tree, function (node, index) {
      if (node.type === 'element' && typeof index === 'number') {
        node.properties.index = index
      }
    })
  }
}

Remove rawSourcePos

The rawSourcePos option was removed, so sourcePos is never passed to components. All components are passed node, so you can get node.position from them.

Remove sourcePos

The sourcePos option was removed, so data-sourcepos is never passed to elements. Write a plugin to pass index:

import {stringifyPosition} from 'unist-util-stringify-position'
import {visit} from 'unist-util-visit'

function rehypePluginAddingIndex() {
  /**
   * @param {import('hast').Root} tree
   * @returns {undefined}
   */
  return function (tree) {
    visit(tree, function (node) {
      if (node.type === 'element') {
        node.properties.dataSourcepos = stringifyPosition(node.position)
      }
    })
  }
}

Remove extra props passed to certain components

When overwriting components, these props are no longer passed:

• inline on code — create a plugin or use pre for the block
• level on h1, h2, h3, h4, h5, h6 — check node.tagName instead
• checked on li — check task-list-item class or check props.children
• index on li — create a plugin
• ordered on li — create a plugin or check the parent
• depth on ol, ul — create a plugin
• ordered on ol, ul — check node.tagName instead
• isHeader on td, th — check node.tagName instead
• isHeader on tr — create a plugin or check children

8.0.7 - 2023-04-12

• c289176 Fix performance for keys by @wooorm in #738
• 9034dbd Fix types in syntax highlight example by @dlqqq in #736

Full Changelog: https://github.com/remarkjs/react-markdown/compare/8.0.6...8.0.7

8.0.6 - 2023-03-20

• 33ab015 Update to TS 5
  by @Methuselah96 in #734

8.0.5 - 2023-01-17

• d640d40 Update to use node16 module resolution in tsconfig.json
  by @ChristianMurphy in #723
• 402fea3 Fix typo in plugins deprecation message
  by @marc2332 in #719
• 4f98f73 Remove deprecated and unneeded defaultProps
  by @Lepozepo in #718

8.0.4 - 2022-12-01

• 9b20440 Fix type of td, th props
  by @lucasassisrosa in #714
• cfe075b Add clarification of alt on img in docs
  by @cballenar in #692

8.0.3 - 2022-04-20

• a2fb833 Fix prop types of plugins
  by @starpit in #683

8.0.2 - 2022-03-31

• 2712227 Update react-is
• 704c3c6 Fix TypeScript bug by adding workaround
  by @Methuselah96 in #676

8.0.1 - 2022-03-14

• c23ecf6 Add missing dependency for types
  by @Methuselah96 in #675

8.0.0 - 2022-01-17

<a name="change-plugins-to-remarkplugins"></a>

• cd845c9 Remove deprecated plugins option
  (migrate by renaming it to remarkPlugins)
• 36e4916 Update remark-rehype, add support for passing it options
  by @peolic in #669
  (migrate by removing remark-footnotes and updating remark-gfm if you were using them, otherwise you shouldn’t notice this)