Skip to content

Releases: jsdoc2md/dmd

v7.1.1

29 Nov 15:28
Compare
Choose a tag to compare

v7.1.0

28 Nov 15:49
Compare
Choose a tag to compare

v7.0.7

25 Sep 16:25
Compare
Choose a tag to compare

Non-breaking

  • Fixed a scenario where --EOL failed to correctly replace naked CR characters created by jsdoc. #102

v7.0.4

01 Sep 10:59
Compare
Choose a tag to compare

Non-breaking

  • Added support for @hideconstructor. #94

v7.0.0

30 Aug 21:54
Compare
Choose a tag to compare

The default dmd output has not changed. The minimum required Node version is still v12.17.

Breaking Changes

  • The exported dmd() method is now async. Removed dmd.async().

Non-breaking Changes

  • Fixed a 'maximum call stack size exceeded' error. The user now gets a warning if the malformed input which formerly caused the error is detected. #89
  • Support clever-links, monospace-links, {@linkcode} and {@linkplain}. #86
  • Fixed an issue where the dmd internal partials failed to load if a user's directory name contained special glob characters. #82
  • Upgraded all deps to their latest versions and factored many old modules out of the project.
  • Added the --EOL option to control line-endings. Fixes #92.

v6.2.0

28 Nov 14:06
Compare
Choose a tag to compare

Minor updates

  • Upgrade to marked v4.2.3
  • Upgrade deps, dates and tested Node versions in CI

v2.0.3

07 Oct 09:34
Compare
Choose a tag to compare

Breaking since 1.4.2

  • Stream interface removed, the exported function (dmd) is now synchronous.
  • For an async (Promise) method, use dmd.async.
  • cli interface removed, use jsdoc2md instead

Non-breaking changes

  • dependency tree cleaned up
  • merged ddata into the module - no longer makes sense for it to be separate
  • memoisation cache added - repeat invocations with the same input return from cache (much faster).

Migrating to v2

Say your v1 code looked like this:

    const data = [ { ... } ]
    let dmdStream = dmd({
      template: 'blah',
      helper: ['./scripts/helpers']
    });

    dmdStream.pipe(fs.createWriteStream('docs.md')));
    dmdStream.end(JSON.stringify(data));

Then the v2 equivalent would look like:

    const data = [ { ... } ]
    const docs = dmd(data, {
      template: 'blah',
      helper: ['./scripts/helpers']
    });

    fs.writeFile('docs.md', docs);

Thanks to @vvo for the example.