Skip to content

Releases: peterpeterparker/tsdoc-markdown

v1.1.0

16 Dec 20:40
Compare
Choose a tag to compare

What's Changed

Full Changelog: v1.0.0...v1.1.0

v1.0.0

05 Dec 10:08
Compare
Choose a tag to compare

What's Changed

Full Changelog: v0.6.3...v1.0.0

v0.6.3

31 Oct 07:41
Compare
Choose a tag to compare

Fix

  • Option to render markdown without emoji was rendering few emojis.

v0.6.2

31 Oct 05:58
Compare
Choose a tag to compare

Fix

  • Concatenate lines when types contain new lines.

Chore

  • Revert unnecessary string cleanup.

v0.6.1

30 Oct 18:05
Compare
Choose a tag to compare

Fix

  • JSDoc descriptions containing pipes were causing issues in Markdown tables.

v0.6.0

18 Apr 10:20
Compare
Choose a tag to compare

Features

  • Generate jsDoc @example content (#28).

Shout-out to mingtianyihou33 for the contributions! 💪

v0.5.0

10 Apr 19:50
Compare
Choose a tag to compare

Features

  • Support for Enum.

Shout-out to mingtianyihou33 for the contributions! 💪

v0.4.0

17 Mar 10:44
Compare
Choose a tag to compare

Features

  • Enable strictNullChecks per default when creating TypeScript compiler program. This allow exporting parameters and results that unions null or undefined.

For example:

/**
 * Markdown should handle ` | ` for the type.
 */
export const genericType = <T>(value: [] | [T]): T | undefined => value?.[0];

Previously did not parsed the result | undefined in the resulting documentation.

v0.3.0

16 Feb 10:31
Compare
Choose a tag to compare

Features

  • Add support for jsDocs in Interfaces when generating markdown.

v0.2.1

16 Feb 06:24
Compare
Choose a tag to compare

Fix

  • Remove backtick for the description of the Interfaces in generated markdown content.