Interface MarkdownOptions

Markdown options.

Hierarchy

MarkdownOptions

Index

Properties

owner? prefix? repo? useWiki? withDescription? withType? wrapText?

Properties

`Optional` owner

owner?: string

GitHub owner name. [owner]

`Optional` prefix

prefix?: string

Namespace prefix.

`Optional` repo

repo?: string

GitHub repo name. [repo]

`Optional` useWiki

useWiki?: boolean

Use wiki links? [false]

`Optional` withDescription

withDescription?: boolean

Include root description? [false]

`Optional` withType

withType?: boolean

Include types? [false]

`Optional` wrapText

wrapText?: number

Wrap comment text after. [0 => unlimited]

Generated using TypeDoc