UNPKG

typedoc-plugin-markdown

Version:

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.

40 lines (39 loc) 1.33 kB
/** * Defines option maps TypeDoc parameter Map types. * * @module */ /** * The allowed values of the `--outputFileStrategy` option. */ export var OutputFileStrategy; (function (OutputFileStrategy) { OutputFileStrategy["Members"] = "members"; OutputFileStrategy["Modules"] = "modules"; })(OutputFileStrategy || (OutputFileStrategy = {})); /** * The allowed values for formatting reflections and indexes. */ export var DisplayFormat; (function (DisplayFormat) { DisplayFormat["List"] = "list"; DisplayFormat["Table"] = "table"; DisplayFormat["HtmlTable"] = "htmlTable"; })(DisplayFormat || (DisplayFormat = {})); /** * The allowed values for the custom anchors format. */ export var CustomAnchorsFormat; (function (CustomAnchorsFormat) { CustomAnchorsFormat["CurlyBrace"] = "curlyBrace"; CustomAnchorsFormat["EscapedCurlyBrace"] = "escapedCurlyBrace"; CustomAnchorsFormat["SquareBracket"] = "squareBracket"; })(CustomAnchorsFormat || (CustomAnchorsFormat = {})); /** * The allowed values for formatting reflections and indexes. */ export var TypeDeclarationVisibility; (function (TypeDeclarationVisibility) { TypeDeclarationVisibility["Compact"] = "compact"; TypeDeclarationVisibility["Verbose"] = "verbose"; })(TypeDeclarationVisibility || (TypeDeclarationVisibility = {}));