v0.4.4

ts-docs

interface TsDocsOptions

Properties

entryPointscustomPagesnamelandingPageoutstructureassetslogoexternalspassthroughModulesbrancheschangelogjsontsconfigforceEmitexportModestripInternalsortdocTeststestlogNotDocumenteddocumentImportsstyleplugins

Search results

Types

Classes

Interfaces

Enums

Functions

Type aliases

Constants

Members

Properties

Methods

Getters

Setters

Enum members

Show privates

Other

In this module only

index / ts-docs / TsDocsOptions

Interface TsDocsOptions

Defined in options.ts

Properties

entryPoints: Arrayexternal Array<string>

customPages?: Arrayexternal Array<PageCategoryinterface PageCategoryts-docs/PageCategory>

landingPage?: LandingPageinterface LandingPagets-docs/LandingPage

structure: string

assets?: string

externals?: Arrayexternal Array<ExternalReferenceinterface ExternalReferenceextractor/extractor/ExternalReference>

passthroughModules?: Arrayexternal Array<string>

branches?: Arrayexternal Array<BranchSettinginterface BranchSettingts-docs/branches/BranchSetting>

changelog?: boolean

tsconfig?: string

forceEmit?: boolean

exportMode: "simple" | "detailed"

stripInternal?: boolean

sort?: "source" | "alphabetical"

docTests?: boolean

logNotDocumented?: Setexternal Set<string>

documentImports?: boolean

forceTheme?: "dark" | "light",
dontCollapseCategories?: boolean

}

markdown?: (

generator: Generatorclass Generatorts-docs/generator/Generator

) => Arrayexternal Array<SingleMarkedExtensiontype SingleMarkedExtensionts-docs/generator/SingleMarkedExtension>

}