Skip to content

Latest commit

 

History

History
384 lines (314 loc) · 17.4 KB

CHANGELOG.md

File metadata and controls

384 lines (314 loc) · 17.4 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

9.2.0 - 2024-09-07

  • Re-export Token and State types from markdown-it. (#135)

9.1.0 - 2024-08-24

  • Introduce a slugifyWithState option. (#125, #134)

9.0.2 - 2024-08-24

  • Support duplicated class attributes. (#133)

9.0.1 - 2024-05-17

  • Fix types following upgrade. (#131)

9.0.0 - 2024-05-16

  • Support markdown-it 14. This may be breaking hence the major. (#129, #128)

8.6.7 - 2023-02-16

  • Fix link in deprecation warning. (#123)

8.6.6 - 2022-12-18

  • npm audit fix. (#121)

8.6.5 - 2022-09-12

  • Support native ESM modules with TypeScript. (#118)

8.6.4 - 2021-05-11

  • Fix linkAfterHeader type to support wrapper tuple. (#116)

8.6.3 - 2021-05-05

  • Fix permalink generator type to return void instead of string. (#115)

8.6.2 - 2021-04-08

  • Fix types to reflect optional permalink arguments and properties. (#114)

8.6.1 - 2021-04-08

  • Fix type for headerLink permalink options. (#108)
  • Allow to customize the space text (e.g. using  ). (#88)

8.6.0 - 2021-04-08

  • Add a getTokensText option to customize how we extract the title text from the heading tokens. (#112)

8.5.0 - 2021-04-04

  • Support wrapping output of linkAfterHeader. (#100, #110)

8.4.1 - 2021-10-11

  • Attempt to fix npm publish that didn't publish previous version.

8.4.0 - 2021-10-11

  • Add a fix for Safari reader view in headerLink. (#107)

8.3.1 - 2021-09-15

  • Update TypeScript types to properly reflect the export style of @types/markdown-it. Also use export default anchor in type declaration instead of export = anchor so that TypeScript allows both import anchor from 'markdown-it-anchor' and import anchor = require('markdown-it-anchor') syntaxes instead of being forced to the latter. (#106)
  • Added a hack to make TypeScript work with the modern import syntax when not being used with a bundler. (6fcc502)

8.3.0 - 2021-08-26

  • Make core loop resilient to permalink renderers mutating the token stream with splice. (#100)

8.2.0 - 2021-08-26

  • Introduce a linkInsideHeader permalink option, which is the closest to the permalink in previous versions. (#101)
  • Refactor tests using AVA.

8.1.3 - 2021-08-24

  • Fix tabIndex type. (#103)

8.1.2 - 2021-07-23

  • Fix prepublish script not being run on npm publish anymore.
  • Update the dist code.

8.1.1 - 2021-07-23

  • Fix ReferenceError with process.emitWarning in the browser. (#102)

8.1.0 - 2021-07-01

  • Add token.meta.isPermalinkSymbol to help other plugins (e.g. TOC) to identify and ignore permalink symbols. (#99)

8.0.5 - 2021-07-01

  • Revert html_inline to html_block in legacy permalink. (#98)

8.0.4 - 2021-06-25

  • Fix level option TypeScript type. (#97)

8.0.3 - 2021-06-20

  • Update TypeScript types compatible with 8.0.0 release. (#95)

8.0.2 - 2021-06-19

  • Fix bug with linkAfterHeader permalink renderer. (#93)
  • Also fix regression where symbol wasn't allowed to be HTML anymore in new renderers.

8.0.1 - 2021-06-15

  • Fix permalink option typo in readme. (#91)

8.0.0 - 2021-06-14

  • Set tabindex="-1" on headers. (#85, #86)
  • Change the way to configure a permalink, allowing for more accessible choices. (#82, #89)
  • Show a deprecation warning for the old permalink option.

7.1.0 - 2021-03-06

  • Update TypeScript types. (#83)

7.0.2 - 2021-02-06

  • Optimize token parsing. (#80)

7.0.1 - 2021-01-28

  • Add a Chinese readme. (#79)

7.0.0 - 2021-01-04

  • Depend on any markdown-it version. (#76)

6.0.1 - 2020-11-19

  • Added example.html test case.
  • Added uniqueSlugStartIndex test case.
  • Fix equal -> strictEqual.
  • Updated dependencies -> found 0 vulnerabilities.

6.0.0 - 2020-09-29

  • Allow to configure unique slug start index, and make it 1 instead of 2 to mimic what markdown-toc, github-slugger, and GitHub itself does by default. This should improve out of the box compatibility with other packages. (#74)

5.3.0 - 2020-05-12

  • Fix support for user defined ids by using markdown-it-attrs.
  • Updated dependencies -> found 0 vulnerabilities.

5.2.7 - 2020-04-01

  • Forgot to build before pushing to npm.

5.2.6 - 2020-02-05

  • Support arbitrary permalink attributes with permalinkAttrs. (#63)

5.2.5 - 2019-10-16

  • Removing aria-hidden from links. (#58)

5.2.4 - 2019-06-03

  • Rolled back to ...linkTokens.
  • Executed npm audit fix to fix dependencies vulnerabilities.

5.2.3 - 2019-05-28

  • ...linkTokens -> (...).apply(null, linkTokens) IE doesn't support spread syntax.

5.2.2 - 2019-05-28

  • ...linkTokens -> [].concat(linkTokens) makes IE compatible.

5.2.1 - 2019-05-28

  • Fix typo.

5.2.0 - 2019-05-28

  • Added support for unpkg
  • Added support for mjs
  • Fix Babel issue, support ES modules. (#40, #46)
  • New option permalinkSpace makes possible to suppress the whitespace between the permalink and the header text value. Defaults to true. (#52)
  • Fix duplicate ID edge case. (#35)

5.0.1 - 2018-06-14

  • trim() before toLowerCase() to prevent dashes as prefixes and suffixes.

5.0.0 - 2018-06-14

4.0.0 - 2017-02-26

  • Drop Babel. This drops support for Node.js versions that doesn't support ES6.
  • Support code in titles. (#27)
  • Support individual header level selection. (#27)

3.0.0 - 2017-02-06

  • Use existing ID as slug if present. This drops the support for markdown-it 5 and lower, hence the major bump. (#22)

2.5.1 - 2016-11-19

  • Patch for supporting "Constructor" title. (#18)

2.5.0 - 2016-03-22

  • Test against markdown-it 6.
  • Support anchors with HTML in header.

2.4.0 - 2016-02-12

  • Add a callback option. (#16)

2.3.3 - 2015-12-21

  • Add a live example. (#13)

2.3.2 - 2015-11-29

  • Test against markdown-it 5.
  • Keep assigning module.exports after Babel 6 upgrade (that assigns exports.default only instead), using babel-plugin-add-module-exports. (#12)

2.3.1 - 2015-11-29

  • Remove hard dependency on markdown-it and replace lodash.assign with Object.assign. (#11)
  • Move to Babel 6.
  • Use babel-plugin-transform-object-assign to have Object.assign work in ES5 environments.
  • Add the permalink during compilation instead of rendering.

2.3.0 - 2015-08-13

  • Allow to pass HTML as permalink symbol. (#8)

2.2.1 - 2015-08-13

  • Do not crash when permalink is enabled and headers below specified level are present. (#7)

2.2.0 - 2015-07-20

  • Use core.ruler to add attributes so other plugins can reuse them. (#5)

2.1.0 - 2015-06-22

  • Set aria-hidden on permalink anchor.

2.0.0 - 2015-05-28

  • Place the permalink after the header by default. (#3)

    If you want to keep the old behavior, set the permalinkBefore option to true:

    const md = require('markdown-it')
  .use(require('markdown-it-anchor'), {
    permalink: true,
    permalinkBefore: true
  })

1.1.2 - 2015-05-23

  • Fix a code example in the readme.

1.1.1 - 2015-05-20

  • Slight tweaks in package.json.
  • Upgrade Babel.

1.1.0 - 2015-04-24

  • Allow to customize the permalink symbol. (#1)
  • Handle duplicate slugs by appending a number.

1.0.0 - 2015-03-18

  • Initial release.