typedoc-plugin-markdown
Version:
A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
36 lines (35 loc) • 796 B
TypeScript
/**
* Defines option maps TypeDoc parameter Map types.
*
* @module
*/
/**
* The allowed values of the `--outputFileStrategy` option.
*/
export declare enum OutputFileStrategy {
Members = "members",
Modules = "modules"
}
/**
* The allowed values for formatting reflections and indexes.
*/
export declare enum DisplayFormat {
List = "list",
Table = "table",
HtmlTable = "htmlTable"
}
/**
* The allowed values for the custom anchors format.
*/
export declare enum CustomAnchorsFormat {
CurlyBrace = "curlyBrace",
EscapedCurlyBrace = "escapedCurlyBrace",
SquareBracket = "squareBracket"
}
/**
* The allowed values for formatting reflections and indexes.
*/
export declare enum TypeDeclarationVisibility {
Compact = "compact",
Verbose = "verbose"
}