Skip to content

Releases: jaydenseric/jsdoc-md

Version 2.0.1

10 Feb 00:38
Compare
Choose a tag to compare

Patch

  • Fix <hr /> incorrectly appearing above non top level members.

Version 2.0.0

10 Feb 00:18
Compare
Choose a tag to compare

Major

  • @kind member now displays an associated @type and throws an error if there is none.

Minor

  • Separate top level member sections with <hr />.

Patch

  • Updated dev dependencies.
  • Use default tap reporter for tests.
  • Simplify package test:js script glob.

Version 1.7.1

30 Jan 13:00
Compare
Choose a tag to compare

Patch

  • Updated dependencies.
  • Allow Babel to load config relative to files being parsed.
  • Stopped automatically linking global types to MDN.
  • Simplified ESLint config.

Version 1.7.0

19 Nov 22:11
Compare
Choose a tag to compare

Minor

  • Added MDN links for Uint8Array types and updated snapshot tests, fixing #11 via #12.

Patch

  • Updated dependencies.
  • Updated package scripts and config for the new husky version.
  • Added a missing test for the Promise type MDN link.

Version 1.6.0

28 Aug 05:05
Compare
Choose a tag to compare

Minor

  • Support Node.js v6+, from v8.5+.

Patch

  • Work around a Babel breaking change to parsing decorators, see babel/babel#8562.

Version 1.5.0

16 Aug 13:12
Compare
Choose a tag to compare

Minor

  • Use mdn.io for shorter MDN links in generated markdown.
  • Promise types now link to their MDN docs.

Patch

  • Updated dependencies.
  • Removed the npm-run-all dev dependency and stopped using it for package scripts.
  • Swapped readme badge order.

Version 1.4.0

09 Aug 05:30
Compare
Choose a tag to compare

Minor

  • Sort members in the documentation outline, fixes #8.
  • Explicitly left align table cell contents.
  • Display parameter and property names as inline code.

Patch

  • Updated dependencies.
  • Configured Prettier to lint .yml files.
  • Ensure the readme Travis build status badge only tracks master branch.
  • Use Badgen for the readme npm version badge.

Version 1.3.0

09 Jul 01:41
Compare
Choose a tag to compare

Minor

  • Default documentation for global types (such as Object) can be overridden using @typedef.
  • Also auto-link MDN articles for global types function and Date.

Patch

  • Varied capitalization of global types (such as Object) results in a consistently lowercase MDN link slug.

Version 1.2.0

07 Jul 05:51
Compare
Choose a tag to compare

Minor

  • Generate function return documentation, fixes #7.

Version 1.1.0

07 Jul 01:44
Compare
Choose a tag to compare

Minor

  • Support JSDoc inline tag links (e.g. [`b` method]{@link A#b}) for descriptions and tags with markdown content, closes #5.

Patch

  • Correct slugs for successive type member links, fixes #6.
  • Display CLI options as code in the readme.
  • Internally refactor jsdocAstToMember to jsdocToMember.