MarkdownTypeDocConfig

@codification/cutwater-build-core > MarkdownTypeDocConfig

Interface

beta:

Hierarchy

TypeDocConfig

↳ MarkdownTypeDocConfig

Properties

Properties

<Optional> entryPoint

● entryPoint: undefined | string

Inherited from TypeDocConfig.entryPoint

Defined in BaseTypeDocTask.ts:29

<Optional> exclude

● exclude: undefined | string

Inherited from TypeDocConfig.exclude

Defined in BaseTypeDocTask.ts:14

<Optional> excludeNotExported

● excludeNotExported: undefined | false | true

Inherited from TypeDocConfig.excludeNotExported

Defined in BaseTypeDocTask.ts:17

<Optional> excludePrivate

● excludePrivate: undefined | false | true

Inherited from TypeDocConfig.excludePrivate

Defined in BaseTypeDocTask.ts:18

<Optional> excludeProtected

● excludeProtected: undefined | false | true

Inherited from TypeDocConfig.excludeProtected

Defined in BaseTypeDocTask.ts:19

<Optional> externalPattern

● externalPattern: undefined | string

Inherited from TypeDocConfig.externalPattern

Defined in BaseTypeDocTask.ts:16

<Optional> gaId

● gaId: undefined | string

Inherited from TypeDocConfig.gaId

Defined in BaseTypeDocTask.ts:28

<Optional> gitRevision

● gitRevision: undefined | string

Inherited from TypeDocConfig.gitRevision

Defined in BaseTypeDocTask.ts:30

<Optional> hideGenerator

● hideGenerator: undefined | false | true

Inherited from TypeDocConfig.hideGenerator

Defined in BaseTypeDocTask.ts:27

<Optional> ignoreCompilerErrors

● ignoreCompilerErrors: undefined | false | true

Inherited from TypeDocConfig.ignoreCompilerErrors

Defined in BaseTypeDocTask.ts:13

<Optional> includeDeclarations

● includeDeclarations: undefined | false | true

Inherited from TypeDocConfig.includeDeclarations

Defined in BaseTypeDocTask.ts:15

<Optional> includes

● includes: undefined | string

Inherited from TypeDocConfig.includes

Defined in BaseTypeDocTask.ts:31

<Optional> json

● json: undefined | string

Inherited from TypeDocConfig.json

Defined in BaseTypeDocTask.ts:12

<Optional> mdDocusaurus

● mdDocusaurus: undefined | false | true

Defined in MarkdownTypeDocTask.ts:10

<Optional> mdEngine

● mdEngine: "github" | "bitbucket" | "gitbook"

Defined in MarkdownTypeDocTask.ts:9

<Optional> mdHideSources

● mdHideSources: undefined | false | true

Defined in MarkdownTypeDocTask.ts:11

<Optional> mdSourceRepo

● mdSourceRepo: undefined | string

Defined in MarkdownTypeDocTask.ts:12

<Optional> media

● media: undefined | string

Inherited from TypeDocConfig.media

Defined in BaseTypeDocTask.ts:32

<Optional> mode

● mode: "file" | "modules"

Inherited from TypeDocConfig.mode

Defined in BaseTypeDocTask.ts:10

<Optional> module

● module: "commonjs" | "amd" | "system" | "umd"

Inherited from TypeDocConfig.module

Defined in BaseTypeDocTask.ts:20

<Optional> name

● name: undefined | string

Inherited from TypeDocConfig.name

Defined in BaseTypeDocTask.ts:24

<Optional> options

● options: undefined | string

Inherited from TypeDocConfig.options

Defined in BaseTypeDocTask.ts:11

<Optional> out

● out: undefined | string

Inherited from TypeDocConfig.out

Defined in BaseTypeDocTask.ts:9

<Optional> plugin

● plugin: undefined | string

Inherited from TypeDocConfig.plugin

Defined in BaseTypeDocTask.ts:26

<Optional> readme

● readme: undefined | string

Inherited from TypeDocConfig.readme

Defined in BaseTypeDocTask.ts:25

src

● src: string

Inherited from TypeDocConfig.src

Defined in BaseTypeDocTask.ts:8

<Optional> target

● target: "ES3" | "ES5" | "ES6"

Inherited from TypeDocConfig.target

Defined in BaseTypeDocTask.ts:21

<Optional> theme

● theme: undefined | string

Inherited from TypeDocConfig.theme

Defined in BaseTypeDocTask.ts:23

<Optional> tsconfig

● tsconfig: undefined | string

Inherited from TypeDocConfig.tsconfig

Defined in BaseTypeDocTask.ts:22