Type Alias GenerateConfig
type GenerateConfig = {
dmtNavStyle?: "compact" | "flat" | "full";
exportCondition?: string;
linkChecker?: boolean;
linkPlugins?: Iterable<"dom" | "es" | "worker">;
logLevel?: _typhonjs_utils_logger_color.LogLevel;
monoRepo?: boolean;
output?: string;
path?: string | Iterable<string>;
tsconfigPath?: string;
typedocOptions?: Partial<typedoc.TypeDocOptions>;
typedocPath?: string;
}
dmtNavStyle?: "compact" | "flat" | "full";
exportCondition?: string;
linkChecker?: boolean;
linkPlugins?: Iterable<"dom" | "es" | "worker">;
logLevel?: _typhonjs_utils_logger_color.LogLevel;
monoRepo?: boolean;
output?: string;
path?: string | Iterable<string>;
tsconfigPath?: string;
typedocOptions?: Partial<typedoc.TypeDocOptions>;
typedocPath?: string;
}
Properties
OptionaldmtNavStyle
dmtNavStyle?: "compact" | "flat" | "full"
OptionalexportCondition
exportCondition?: string
The export condition to query for package.json entry points.
OptionallinkChecker
linkChecker?: boolean
Enable debug TypeDoc logging with a unknown symbol link checker.
OptionallinkPlugins
All API link plugins to load.
OptionallogLevel
Defines the logging level; default: 'info'.
OptionalmonoRepo
monoRepo?: boolean
When true a single directory path must be specified that will be scanned for all NPM packages.
Optionaloutput
output?: string
Provide a directory path for generated documentation.
Optionalpath
Path to a source file, package.json, or directory with a
package.json to use as entry points; you may provide an iterable list of paths.
OptionaltsconfigPath
tsconfigPath?: string
Path to custom tsconfig.json to load.
OptionaltypedocOptions
Direct TypeDoc options to set.
OptionaltypedocPath
typedocPath?: string
Path to custom typedoc.json to load.
Modify navigation module paths to be flat or compact singular paths; default: 'full'.