Type alias GenerateConfig

    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;
    }

    Type declaration

    • Optional dmtNavStyle?: "compact" | "flat" | "full"

      Modify navigation module paths to be flat or compact singular paths; default: 'full'.

    • Optional exportCondition?: string

      The export condition to query for package.json entry points.

    • Optional linkChecker?: boolean

      Enable debug TypeDoc logging with a unknown symbol link checker.

    • Optional linkPlugins?: Iterable<"dom" | "es" | "worker">

      All API link plugins to load.

    • Optional logLevel?: _typhonjs_utils_logger_color.LogLevel

      Defines the logging level; default: 'info'.

    • Optional monoRepo?: boolean

      When true a single directory path must be specified that will be scanned for all NPM packages.

    • Optional output?: string

      Provide a directory path for generated documentation.

    • Optional path?: string | Iterable<string>

      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.

    • Optional tsconfigPath?: string

      Path to custom tsconfig.json to load.

    • Optional typedocOptions?: Partial<typedoc.TypeDocOptions>

      Direct TypeDoc options to set.

    • Optional typedocPath?: string

      Path to custom typedoc.json to load.

    Settings

    Member Visibility

    Theme