v15.0.1

Compare Source

• 54ee687 Fix typo

Full Changelog: remarkjs/remark@15.0.0...15.0.1

v15.0.0

Compare Source

Change

• 98a2560 Change to require Node.js 16
  migrate: update too
• a3e6d54 Change to use exports
  migrate: don’t use private APIs
• 943f6ac Update @types/mdast, mdast-util-{from,to}-markdown, unified, etc
  migrate: update too
  remark-parse: only really changes Buffer -> Uint8Array, so use encodings supported by TextDecoder if you are passing binary data
  remark-stringify: bulletOrderedOther is removed, you can remove bulletOrderedOther if you passed it, it’s now the default;
  fences is now true by default, if you don’t want indented code, pass fences: false;
  listItemIndent is now 'one' by default, you can remove listItemIndent: 'one' if you passed it, or explicitly set it to 'tab' if you want it

Types

• bd8c922 Add typed settings

Docs

• 7cc0432 Add remark-link-rewrite to list of plugins
  by @​rjanjic in #​1212
• e72d91a Add remark-mentions to list of plugins
  by @​FinnRG in #​1193

Full Changelog: remarkjs/remark@14.0.3...15.0.0

v14.0.3

Compare Source

Misc

• Rerelease types for changes in TypeScript
  for #​1162
• f6bd64e Refactor tsconfigs for perf and strictness
• bb4c814 Add improved docs on what this project is
  by @​BeLi4L in #​1147
• bec44aa Update tsconfig.json to use node16 module resolution
  by @​ChristianMurphy in #​1106
• f07f413 Add ignore-scripts to .npmrc
  by @​ChristianMurphy in #​1103
• 134ece2 Update Actions
  by @​ChristianMurphy in #​1070
• 974f893 Fix internal types for TS 4.9

Plugins

• 1e488d0 Add remark-ins to list of plugins
  by @​talatkuyuk in #​1129
• e456dc5 Add remark-flexible-markers to list of plugins
  by @​talatkuyuk in #​1126
• 42114fc Add remark-flexible-paragraphs to list of plugins
  by @​talatkuyuk in #​1120
• 6aa638a Add remark-flexible-containers to list of plugins
  by @​talatkuyuk in #​1112
• 20e7543 Add remark-flexible-code-titles to list of plugins
  by @​talatkuyuk in #​1108
• 32d6948 Add remark-cloudinary-docusaurus to list of plugins
  by @​johnnyreilly in #​1090
• 28aa8b9 update tests for changes in mdast-util-to-markdown
• 9af1a87 Add remark-code-title to list of plugins
  by @​kevinzunigacuellar in #​1076
• 0d1eb09 Add 7 plugins to list of plugins
  by @​Xunnamius in #​1064
• c7e8171 Remove deprecated remark-jargon
  by @​LunaticMuch in #​1059

Full Changelog: remarkjs/remark@14.0.2...14.0.3

v14.0.2

Compare Source

• 87c50a5 Add improved docs
  by @​wooorm in #​900

Full Changelog: remarkjs/remark@14.0.1...14.0.2

v14.0.1

Compare Source

• 9026568 Add missing types dependency

v14.0.0

Compare Source

• b7afd25 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

• 42d1b21 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)
• bc55caa Add JSDoc based types

v13.0.0: (micromark)

Compare Source

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!

v10.0.1

Compare Source

(this is also a patch release for all packages)

Types

• cd07d38 Refactor internal types for better option coercion
• 0c3b4c8 Add type for callback-style async rule
• 70f5120 Fix for changes in typescript
• ea19649 Refactor to use @import

Miscellaneous

• 46ccbcd Fix missing dependency
• 141c419 Fix version numbers
• 875fcaf Refactor docs
• 7110271 Remove license year
• e0d94a8 Refactor docs
• e8e1ac1 Refactor to remove http: where possible
• bbd8fff Remove unneeded fields from package.jsons

Full Changelog: remarkjs/remark-lint@10.0.0...10.0.1

v10.0.0

Compare Source

(this is a major for each package maintained here)

Change

• 943a574 Change to require Node.js 16
  migrate: update too
• 625f7f9 Change to use exports
  migrate: don’t use private APIs
• 255ca39 Update unified, @types/mdast, etc
  migrate: update too
• 8df41b3 remark-preset-lint-recommended: change to prefer remark-lint-list-item-indent: 'one'
  migrate: pass tab if you want previous behavior
• 63d132d remark-preset-lint-consistent: add remark-lint-ordered-list-marker-value
  migrate: turn off or configure with what you prefer
• ccea691 remark-list-item-indent: change default to one
  migrate: pass tab if you want previous behavior
• 07140bd remark-list-item-indent: rename space to one, tab-size to tab
• 7ca5d3c unified-lint-rule: rename RuleMeta type to Meta
• 906012e Remove deprecated (pre CommonMark) remark-lint-no-inline-padding
• 9cdda80 Remove deprecated (pre CommonMark) remark-lint-no-auto-link-without-protocol

Add

• 45aeac2 Add better messages, rewrite and improve rules
• 655ba54 Add better support for gfm, directives, math, mdx
• 18e669f remark-lint-file-extension: add option to disallow extensionless
• 4057f15 remark-lint-no-empty-url: add check for #

Fix

• 802f78f remark-lint-table-pipe-alignment: fix empty centered cell

Docs

• 9a7f129 Regenerate screenshot.png
• 99bbed2 e9b3f7e 547188e Refactor docs

Misc

• b4a6556 Fix autogenerated types w/ TS 5.4
• bd9ba2c Add declaration maps
• e55606e Refactor to improve performance of deep trees
• 627363b Refactor more code, improve small things
• 19251fc 0e79b65 Refactor code-style
• db4810d Refactor remark config
• f8be2e3 Refactor .editorconfig
• 36e844e Refactor .gitignore
• ae313bf Refactor package.json
• 16bf9dc Refactor .npmrc
• f0a475c Refactor package.jsons
• 904edde Refactor tsconfig.jsons
• 96c25af Refactor Actions

Full Changelog: remarkjs/remark-lint@9.1.2...10.0.0

v9.1.2

Compare Source

Fix

• 639271a Fix table alignment related rules for micromark changes
  (remark-lint-table-cell-padding, remark-lint-table-pipe-alignment)
• 5bdc23b Check urls from definitions
  (remark-lint-no-empty-url) by @​Xunnamius in #​299

Misc

• db9755f Refactor types
• 0beb67b Refactor tsconfigs to improve build perf
• f41df8e Fix this type in TS 4.9
  by @​ChristianMurphy in #​304
• 65f0ff9 cabbe86 Add 3 new rules to list of community rules
  by @​Xunnamius in #​301
• 0f6bb40 Remove boolean fallback for ancient remark
  by @​jablko in #​284
• d1e24ff Fix types of rule arguments
  by @​jablko in #​289
• 29bb3b7 Refactor to improve internal severity coercion
  by @​jablko in #​287

Full Changelog: remarkjs/remark-lint@9.1.1...9.1.2

v9.1.1

Compare Source

• 014fca7 Add improved docs
  by @​wooorm in #​276

Full Changelog: remarkjs/remark-lint@9.1.0...9.1.1

v9.1.0

Compare Source

• 201e995 Add urls pointing to docs on all messages
  by @​remcohaszing in #​273

Full Changelog: remarkjs/remark-lint@9.0.1...9.1.0

v9.0.1

Compare Source

• bc1b092 Use npm workspaces (and fix types)
• 359cd08 Add repository.directory field to package.jsons

v9.0.0

Compare Source

• f5cb7d2 Use ESM

  // From CommonJS
  var remarkPresetLintRecommended = require('remark-preset-lint-recommended')
  
  // To ESM
  import remarkPresetLintRecommended from 'remark-preset-lint-recommended'

  Learn more about ESM in this guide
• 1a1e7cc Add JSDoc based types
• 4a832b1 cd80985 ef89686 Remove internal fallbacks for ancient remark
• e3ddd9e b81b38a 27a96be Update dependencies
• 28d4e50 13b1971 6de4fb7 16c1b6f Refactor code-style
• e7a7701 Update docs

Full Changelog: remarkjs/remark-lint@8.0.0...9.0.0

v8.0.0

Compare Source

• 7791db9 Update for micromark in remark@13

TL;DR: Use the new versions of the presets with remark 13:

• remark-preset-lint-consistent (4.0.0)
• remark-preset-lint-markdown-style-guide (4.0.0)
• remark-preset-lint-recommended (5.0.0)

Most plugins are fine, but some received majors. The following plugins are made for the new parser and do not work on the old. While you’re still on remark 12, use their previous version. Use the new versions for remark 13+.

• remark-lint-checkbox-character-style (3.0.0)
• remark-lint-checkbox-content-indent (3.0.0)
• remark-lint-list-item-bullet-indent (3.0.0)
• remark-lint-list-item-spacing (3.0.0)
• remark-lint-no-blockquote-without-marker (4.0.0)
• remark-lint-no-heading-indent (3.0.0)
• remark-lint-no-paragraph-content-indent (3.0.0)
• remark-lint-no-table-indentation (3.0.0)
• remark-lint-table-cell-padding (3.0.0)
• remark-lint-table-pipes (3.0.0)

These plugins generally work on old and new remark, but might miss some messages in the old one now:

• remark-lint-no-consecutive-blank-lines (3.0.0) (extra blank lines can no longer break out of lists)
• remark-lint-no-heading-content-indent (3.0.0) (pedantic mode no longer supported)
• remark-lint-no-inline-padding (3.0.0) (emphasis, strong, strikethrough can’t be padded anymore)
• remark-lint-no-undefined-references (3.0.0) (undefined references are no longer parsed, so we have to do magic to find them)