remark

• a185821b Update internal import-meta-resolve

Full Changelog: https://github.com/remarkjs/remark/compare/[email protected]@12.0.1

• 54ee687c Fix typo

Full Changelog: https://github.com/remarkjs/remark/compare/15.0.0...15.0.1

Change

• 98a25602 Change to require Node.js 16
  migrate: update too
• a3e6d54f Change to use exports
  migrate: don’t use private APIs
• 943f6ac9 Update @types/mdast, mdast-util-{from,to}-markdown, unified, etc
  migrate: update too

Types

• bd8c922f Add typed settings

Docs

• 7cc04328 Add remark-link-rewrite to list of plugins
  by @rjanjic in https://github.com/remarkjs/remark/pull/1212
• e72d91a0 Add remark-mentions to list of plugins
  by @FinnRG in https://github.com/remarkjs/remark/pull/1193

Full Changelog: https://github.com/remarkjs/remark/compare/14.0.3...15.0.0

(see 15.0.0)

(see 15.0.0)

(see 15.0.0)

See [email protected]

See [email protected]

Misc

• Rerelease types for changes in TypeScript
  for https://github.com/remarkjs/remark/issues/1162
• f6bd64e6 Refactor tsconfigs for perf and strictness
• bb4c8143 Add improved docs on what this project is
  by @BeLi4L in https://github.com/remarkjs/remark/pull/1147
• bec44aa0 Update tsconfig.json to use node16 module resolution
  by @ChristianMurphy in https://github.com/remarkjs/remark/pull/1106
• f07f413f Add ignore-scripts to .npmrc
  by @ChristianMurphy in https://github.com/remarkjs/remark/pull/1103
• 134ece2b Update Actions
  by @ChristianMurphy in https://github.com/remarkjs/remark/pull/1070
• 974f8936 Fix internal types for TS 4.9

Plugins

• 1e488d0b Add remark-ins to list of plugins
  by @talatkuyuk in https://github.com/remarkjs/remark/pull/1129
• e456dc5b Add remark-flexible-markers to list of plugins
  by @talatkuyuk in https://github.com/remarkjs/remark/pull/1126
• 42114fc6 Add remark-flexible-paragraphs to list of plugins
  by @talatkuyuk in https://github.com/remarkjs/remark/pull/1120
• 6aa638ab Add remark-flexible-containers to list of plugins
  by @talatkuyuk in https://github.com/remarkjs/remark/pull/1112
• 20e75435 Add remark-flexible-code-titles to list of plugins
  by @talatkuyuk in https://github.com/remarkjs/remark/pull/1108
• 32d69488 Add remark-cloudinary-docusaurus to list of plugins
  by @johnnyreilly in https://github.com/remarkjs/remark/pull/1090
• 28aa8b9a update tests for changes in mdast-util-to-markdown
• 9af1a876 Add remark-code-title to list of plugins
  by @kevinzunigacuellar in https://github.com/remarkjs/remark/pull/1076
• 0d1eb09a Add 7 plugins to list of plugins
  by @Xunnamius in https://github.com/remarkjs/remark/pull/1064
• c7e81713 Remove deprecated remark-jargon
  by @LunaticMuch in https://github.com/remarkjs/remark/pull/1059

Full Changelog: https://github.com/remarkjs/remark/compare/14.0.2...14.0.3

• 145019c4 Update unified-args
  breaking: remove support for Node 12
  tiny chance of breaking: this adheres properly to YAML 1.2
  tiny chance of breaking: this matches modern node in how to resolve plugins
  by @remcohaszing in https://github.com/remarkjs/remark/pull/1008

Full Changelog: https://github.com/remarkjs/remark/compare/[email protected]

• 87c50a58 Add improved docs
  by @wooorm in https://github.com/remarkjs/remark/pull/900

Full Changelog: https://github.com/remarkjs/remark/compare/14.0.1...14.0.2

See [email protected]

See [email protected]

See [email protected]

• a0ef3536 remark-stringify: fix types to disallow options.extensions
  by @JounQin in #874

• 9026568a Add missing types dependency

• b7afd254 Use ESM

  • Change:

    // From CommonJS
    var remark = require('remark')
    
    // To ESM
    import {remark} from 'remark'
    
    // Plugins use default exports:
    var remarkParse = require('remark-parse') // => import remarkParse from 'remark-parse'
    var remarkStringify = require('remark-stringify') // => import remarkStringify from 'remark-stringify'
    

    Learn more about ESM in this guide

• 42d1b212 Update dependencies
  • Update unified (10.0.0) (see: https://github.com/unifiedjs/unified/releases/tag/10.0.0)
  • Update vfile (5.0.0) (see: https://github.com/vfile/vfile/releases/tag/5.0.0)
    Importantly this renames vfile.contents to vfile.value
  • Update mdast-util-from-markdown (1.0.0) (see: https://github.com/syntax-tree/mdast-util-from-markdown/releases/tag/1.0.0)
  • Update mdast-util-to-markdown (1.0.0) (see: https://github.com/syntax-tree/mdast-util-to-markdown/releases/tag/1.0.0)
• bc55caa4 Add JSDoc based types

This is a giant change for remark. It replaces the 5+ year old internals with a new low-level parser: micromark. The old internals have served billions of users well over the years, but markdown has changed over that time. micromark comes with 100% CommonMark (and GFM as an extension) compliance, and (WIP) docs on parsing rules for how to tokenize markdown with a state machine. micromark, and micromark in remark, is a good base for the future.

Migration

• Update all the remark* packages you are using in package.json
• Did you use GFM (tables and so, used to be the default)? Now add remark-gfm
• Try running it all. If it fails, you are probably using a syntax extension which hasn’t been updated yet, there are issues open on the issue trackers of those plugins already
• Compare the previous output to the new output: anything wrong? See below for the changelog which might cover it. Otherwise, It’s probably because remark is now CommonMark (or GFM) compliant.
  Please compare with those projects if the new behavior is correct or not (CommonMark Dingus, or create a gist for GFM).
  Does remark not match those reference parsers? Please open an issue here!

Changes

remark-parse

remark-parse now defers its work to micromark and mdast-util-from-markdown. micromark is a new, small, complete, and CommonMark compliant low-level markdown parser. from-markdown turns its tokens into the previously (and still) used syntax tree: mdast. Extensions to remark-parse work differently: they’re a two-part act. See for example micromark-extension-footnote and mdast-util-footnote.

• change: commonmark is no longer an option — it’s the default
• move: gfm is no longer an option — moved to remark-gfm
• remove: pedantic is no longer an option — this legacy and buggy flavor of markdown is no longer widely used
• remove: blocks is no longer an options — it’s no longer suggested to change the internal list of HTML “block” tag names

remark-stringify

remark-stringify now defers its work to mdast-util-to-markdown. It’s a new and better serializer with powerful features to ensure serialized markdown represents the syntax tree (mdast), no matter what plugins do. Extensions to it work differently: see for example mdast-util-footnote.

options

• change: commonmark is no longer an option, it’s the default
• change: emphasis now defaults to *
• change: bullet now defaults to *
• move: gfm is no longer an option — moved to remark-gfm
• move: tableCellPadding — moved to remark-gfm
• move: tablePipeAlign — moved to remark-gfm
• move: stringLength — moved to remark-gfm
• remove: pedantic is no longer an option — this legacy and buggy flavor of markdown is no longer widely used
• remove: entities is no longer an option — with CommonMark there is almost never a need to use character references, as character escapes are preferred
• new: quote — you can now prefer single quotes (') over double quotes (") in titles

Changes to output / the tree

All of these are for CommonMark compatibility. They’re all fixes. Most of them are inconsequential to most folks.

• notable: references (as in, links [text][id] and images ![alt][id]) are no longer present as such in the syntax tree if they don’t have a corresponding definition ([id]: example.com). The reason for this is that CommonMark requires [text *emphasis start][undefined] emphasis end* to be emphasis.
• notable: it is no longer possible to use two blank lines between two lists or a list and indented code. CommonMark prohibits it. For a solution, use an empty comment to end lists (<!---->)
• inconsequential: whitespace at the start and end of lines in paragraphs is now ignored
• inconsequential: <mailto:foobarbaz> are now correctly parsed, and the scheme is part of the tree
• inconsequential: indented code can now follow a block quote w/o blank line
• inconsequential: trailing indented blank lines after indented code are no longer part of that code
• inconsequential: character references and escapes are no longer present as separate text nodes
• inconsequential: character references which HTML allows but CommonMark doesn’t, such as &copy w/o the semicolon, are no longer recognized
• inconsequential: the indent field is no longer available on position
• fix: multiline setext headings
• fix: lazy lists
• fix: attention (emphasis, strong)
• fix: tabs
• fix: empty alt on images is now present as an empty string
• …plus a ton of other minor previous differences from CommonMark

Thanks

Thanks to Salesforce, Gatsby, Vercel, and Netlify, and our other backers for sponsoring the work on micromark!
To support our continued work, back us on OpenCollective!

See [email protected]

See [email protected]