Skip to content

Latest commit

 

History

History
146 lines (81 loc) · 8.36 KB

CHANGELOG.md

File metadata and controls

146 lines (81 loc) · 8.36 KB
Raw

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

3.1.0 (2019-12-24)

Bug Fixes

  • escape terms containing characters with special meaning in regExp (1815304)
  • v3.0.0 linkified headings don't play well with vuepress. Closes #48. (e9485f2)

Deprecation Notices

  • Value range 'string' of config option 'generateFiles.indexFile'. Use object instead (see README.md). (ceb7e0c)

Features

  • Custom page title for generated index file can now be set. (0b98e43)
  • link usage of (other) terms in a term's glossary definition. (671d1ee)

3.0.0 (2019-12-14)

⚠ BREAKING CHANGES

  • v3.0.0: End of support for nodejs 8.x (LTS). Versions of glossarify-md >= 3.0.0 may continue to work with nodejs 8.x but may also begin to use JS language features and APIs earliest available with nodejs 10.x LTS. Such changes may be introduced with any new version including bugfix versions and without notice or classification of being breaking changes to nodejs 8.x users.
  • With this change section headings will be automatically linkified. URL fragments of section headings may change thus affecting inter-document cross-links or bookmarks of already published documentation. Note: links and bookmarks will continue to point the same page yet not the correct section on that page. Prior section headings which have manually been wrapped into markdown link brackets may get wrapped twice. Review any output prior to publishing it.

Documentation Updates

  • CONTRIBUTING.md: Rework debug section (25a1288)

Features

  • Report on glossary terms never mentioned in text (#43) (96a7415)

  • 3 support backlinks from definition to usage (#46) (9d06dd6), closes #46 #3

  • v3.0.0: New node support matrix (#45) (#47) (c140016)

2.1.1 (2019-12-04)

Bug Fixes

  • In cases where the alias began with the term as a substring, then ocurrences of the alias were no longer linked. For example if the term is Cat and the alias is Cats, then occurrences of Cats were no longer linked to the glossary term Cat. (#41) (4ace562)

2.1.0 (2019-10-04)

Features

2.0.1 (2019-10-04)

Bug Fixes

  • Glossary-terms flanked by ( or ) wouldn't get linked (#37) (ee998e7)
  • remove Firefox remote debugging. Not for nodejs. (8d77ce2)

Documentation Updates

  • README.md: Fix document output example (replace inline link with reference) (d3d147e)
  • vuepress: Include a link to vuepress issue 1815. (62f19e7)

2.0.0 (2019-10-01)

⚠ BREAKING CHANGES

  • cli: No --baseDir and --outDir default values anymore. You will be asked for explicit values if none provided.
  • cli: Now stops if --baseDir and --outDir resolve to the same directory to prevent accidental overwriting of source files. Can be ignored with --force flag.
  • cli: CLI options now take precedence over config file options, if the same option exists in the config file loaded via --config and as a command line argument.

Bug Fixes

  • Short description not correctly extracted (#30) (eff54b4)
  • Runtime error path.absolute is not a function for configuration linking: absolute and baseUrl: "" (538c65d)
  • cli: CLI argument handling and defaults (c55cee0)
  • test: Make npm run commit-baseline run tests first. Reset git index before commit and include new test artifacts on commit. (19fd039)

Features

  • Option to let user define position of term hint (#10) (0569652)

1.1.3 (2019-09-26)

Bug Fixes

  • Aliases: Trailing comma causes infinite loop with out-of-memory failure (#26). (d5ddd5b)

Documentation Updates

  • CONTRIBUTING.md: Using glossarify-md debug config and experimental debugging (7c47169)
  • README.md: Update sample. Fix wrong default value for 'baseDir'. (7959d80)

1.1.2 (2019-09-25)

Bug Fixes

  • dangling anchor links with german umlauts (#27). See updates to doc/vuepress.md and slugify option. (475d692)
  • package.json declares wrong 'main' (0dc107d)
  • Security. Update package-lock.json for use of handlebars@^4.3.1 (f464ceb)
  • Terms with leading or trailing Umlauts/Non-ASCII chars not linked (#28). (0c7f1da)

Documentation Updates

  • vuepress: Add more info on implications of changing vuepress slugifier (065914b)
  • vuepress: npm start should serve from src for live-reloading (8930098)
  • vuepress: Use glossarify-md slugger with vuepress (c707566)

1.1.1 (2019-09-16)

1.1.0 (2019-09-15)

Features

1.0.0

Features:

  • Glossary Linking
  • Multiple Glossaries
  • Aliases
  • Case-insensitive linking (via option)
  • Term Hints
  • Ignored Files
  • Excluded Files
  • Supported Platforms: Linux, Windows, macOS