v5.2.0

chore(release): v5.2.0

v5.1.3

chore(release): v5.1.3

v5.1.2

chore(release): v5.1.2

v5.1.1

chore(release): v5.1.1

v5.1.0

chore(release): v5.1.0

v5.0.1

chore(release): v5.0.1

v5.0.0

Changelog

Notable changes since v4.0.1.

⚠ BREAKING CHANGES

• NodeJS 10.x will no longer be supported for glossarify-md versions >= 5.0.0. While v5.0.0-alpha.* and v5.0.0-beta.0 have been continuously tested on NodeJS 10.x beginning with the release of gossarify-md v5 tests will target NodeJS 12.x (LTS), 14.x (LTS) and 15.x (Current), only. Updates to glossarify-md >= 5.0.0 may break on NodeJS 10 without explictly notifying about a breaking change.

• File extension "mkdown" no longer supported. Aligning with GitHub-supported file extensions.

• Option linking has become linking.paths.
  Option baseUrl has become linking.baseUrl.

  An upgrade assistant will help with the migration. From this version on configuration files must
  refer to a schema by means of a versioned path. This helps the upgrade assistant in future releases to find out what changes need to be applied
  to upgrade from an old schema.

• Terms found in HTML markup won't be linkified any longer.

• Migrating to [email protected] with [email protected] and new micromark parser (#132)

  With remark-parse having switched to a
  completely new yet CommonMark compatible markdown parser
  there's a (minor) risk that output produced by glossarify-md
  changed. Based on what we observed by comparing outputs with our previous baseline there were only marginal changes which make output even more compliant with CommonMark. These are the changes we accepted as part of our new test baseline:

  Indentation: Remark strips leading spaces on new lines
  either because there is no syntax construct which requires
  them or to correct indentation, e.g. of list items.

  Headings: Remark lifts headings at a depth > 6 into
  the valid range of 1-6 according to CommonMark Spec v0.29.

  Escapes: There may be a few changes to what is being
  escaped by a leading backslash. See remark for details.

  The remark changelog can be found here:
  https://github.com/remarkjs/remark/releases/tag/13.0.0

• For unordered lists glossarify-md now writes the star marker "*". Previously it wrote dashes "-". For emphasis it now uses the star marker as well. Previously it used underscores.

  Since both is equally Markdown this is only a breaking change in terms of output similarity not in terms of Markdown rendering. We therefore do not provide any upgrade assistance to keep results the same. If you still care you can restore previous results by adding below snippet to your glossary-md.conf.json. However, we do not give any guarantees about identical outputs in the next major release, anyway.

  "unified": {
    "settings": {
      "bullet": "-",
      "emphasis": "_"
    }
  }

Features

• New node support matrix (#145) (07b95b0)
• cli: New options --new and --more usable with --init. See README.md for details. (02240d3)
• docs: Demonstrate glossarify-md in the docs by generating ./doc/ from ./demo (#143) (88a8b96)
• Markdown syntax extensions via plug-ins.
  • New option unified for extended markdown processing configuration (#140) (49a2dce).
    This opens up a whole lot of new possibilities and enables using glossarify-md on Markdown inputs not strictly adhering to [CommonMark]. Make sure to read the README.md.
• Cross linking
  • glossary file globs (#133) (705f9a0)
  • identifier-based cross-linking with pandoc-style custom-heading-ids (#122) (949c815)
  • New option linking.headingDepths. Select heading depths to generate term-based links for. (#136) (d4c8646)
  • New option linking.limitByAlternatives (#137) (98cb9d0)
  • New option indexing.headingDepths (#139) (37c7b1e), closes #136
  • New README.md section on Cross Linking
• New option linking.terms. Limiting the number of glossary links to once per paragraph (#118) (0310e93), closes #117 #127
• cli: New parameter --init to generate a config file with all options and defaults (#126) (04894ce)
• Allow lists from arbitrary identifiable HTML nodes (1342a69)
• Anchors for direct navigation to images and tables and unified lists (2175d8b)
• Improved performance (2e9f9dc)
• Support pandoc-style custom heading ids (#112) (4ef0fe7)
• Allow lists from arbitrary identifiable HTML nodes (1342a69)
• Anchors for direct navigation to images and tables and unified lists.. See also README Section Lists (2175d8b)
• Improved performance (2e9f9dc)

Bug Fixes

• Default Config Values: outDir being in default baseDir (ea0a144)
• Use GitHub set of supported Markdown file extensions. (745fd82)
• Being more robust if no glossary file is available.
• Deeply merge configuration schema defaults (#124) (1583ff0)
• Linkification in embedded HTML markup (#110) (5da4415)
• Conf schema upgrade and upgrade assistant (#128) (1eb152f), closes #128
• Linkification in embedded HTML markup (#110) (5da4415)

v4.0.1

chore(release): v4.0.1

4.0.0

v4.0.0

Bump version

v3.6.5

chore(release): 3.6.5