v0.6.3

Fix

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

v0.6.2

Fix

• Concatenate lines when types contain new lines.

Chore

• Revert unnecessary string cleanup.

v0.6.1

Fix

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

v0.6.0

Features

• Generate jsDoc @example content (#28).

---

Shout-out to mingtianyihou33 for the contributions! 💪

v0.5.0

Features

• Support for Enum.

---

Shout-out to mingtianyihou33 for the contributions! 💪

v0.4.0

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

Features

• Add support for jsDocs in Interfaces when generating markdown.

v0.2.1

Fix

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

v0.2.0

Features

• Support for generating documentation for interfaces and types. This new feature is optional and can be enabled using the build options --types.

v0.1.0

Features

• upgrade to typescript@^5 (#13)

Docs

• use all-contributors do showcase contributors on README (#15)

Build

• release to npm from CI with provenance flag

---

Shout-out to mia-riezebos for the contributions! 💪