ts-json-definition-transpiler/docs/targets/markdown.md

Markdown

Generates a Markdown file for every source file, containing documentation for defined types generated from documentation comments as well as the type definitions themselves.

Options

The Markdown renderer currently has no options.

Supported JSDoc features

JSDoc	Markdown
Description	Description
@title	Heading
@default	Default
@deprecated	Deprecated
@markdown	Type: Markdown-formatted text
@minLength	Minimum Length
@maxLength	Maximum Length
@pattern	Pattern
@format	Format
@integer	Type: Integer
@minimum	Minimum
@maximum	Maximum
@exclusiveMinimum	Exclusive Minimum
@exclusiveMaximum	Exclusive Maximum
@multipleOf	Multiple of
@minItems	Minimum Items
@maxItems	Maximum Items
@uniqueItems	Unique Items
@minProperties	Minimum Properties
@maxProperties	Maximum Properties
@patternProperties	Values matching pattern
readonly modifier	Read-only property