Interface TypeDocOptionValues

interface TypeDocOptionValues {
    alwaysCreateEntryPointModule: boolean;
    basePath: NormalizedPath;
    blockTags: `@${string}`[];
    cacheBust: boolean;
    cascadedModifierTags: `@${string}`[];
    categorizeByGroup: boolean;
    categoryOrder: string[];
    cleanOutputDir: boolean;
    cname: string;
    commentStyle: "jsdoc" | "block" | "line" | "triple-slash" | "all";
    compilerOptions: unknown;
    customCss: NormalizedPath;
    customFooterHtml: string;
    customFooterHtmlDisableWrapper: boolean;
    customJs: NormalizedPath;
    darkHighlightTheme: BundledTheme;
    defaultCategory: string;
    disableGit: boolean;
    disableSources: boolean;
    displayBasePath: NormalizedPath;
    emit: "none" | "both" | "docs";
    entryPoints: GlobString[];
    entryPointStrategy: "expand" | "resolve" | "packages" | "merge";
    exclude: GlobString[];
    excludeCategories: string[];
    excludeExternals: boolean;
    excludeInternal: boolean;
    excludeNotDocumented: boolean;
    excludeNotDocumentedKinds: KindString[];
    excludePrivate: boolean;
    excludePrivateClassFields: boolean;
    excludeProtected: boolean;
    excludeReferences: boolean;
    excludeTags: `@${string}`[];
    externalPattern: GlobString[];
    externalSymbolLinkMappings: ManuallyValidatedOption<
        Record<string, Record<string, string>>,
    >;
    favicon: NormalizedPath;
    githubPages: boolean;
    gitRemote: string;
    gitRevision: string;
    groupOrder: string[];
    groupReferencesByType: boolean;
    headings: { document: boolean; readme: boolean };
    help: boolean;
    hideGenerator: boolean;
    highlightLanguages: string[];
    hostedBaseUrl: string;
    html: NormalizedPath;
    ignoredHighlightLanguages: string[];
    includeHierarchySummary: boolean;
    includeVersion: boolean;
    inlineTags: `@${string}`[];
    intentionallyNotDocumented: string[];
    intentionallyNotExported: string[];
    jsDocCompatibility: JsDocCompatibility;
    json: NormalizedPath;
    kindSortOrder: KindString[];
    lang: string;
    lightHighlightTheme: BundledTheme;
    locales: ManuallyValidatedOption<Record<string, Record<string, string>>>;
    logLevel: LogLevel;
    markdownItLoader: (parser: any) => void;
    markdownItOptions: ManuallyValidatedOption<Record<string, unknown>>;
    markdownLinkExternal: boolean;
    maxTypeConversionDepth: number;
    modifierTags: `@${string}`[];
    name: string;
    navigation: {
        compactFolders: boolean;
        excludeReferences: boolean;
        includeCategories: boolean;
        includeFolders: boolean;
        includeGroups: boolean;
    };
    navigationLeaves: string[];
    navigationLinks: ManuallyValidatedOption<Record<string, string>>;
    notRenderedTags: `@${string}`[];
    options: NormalizedPath;
    out: NormalizedPath;
    outputs: OutputSpecification[];
    packageOptions: TypeDocPackageOptions;
    packagesRequiringDocumentation: string[];
    plugin: NormalizedPathOrModuleOrFunction[];
    preservedTypeAnnotationTags: `@${string}`[];
    preserveLinkText: boolean;
    preserveWatchOutput: boolean;
    pretty: boolean;
    projectDocuments: GlobString[];
    readme: string;
    requiredToBeDocumented: KindString[];
    router: string;
    searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>;
    searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>;
    searchInComments: boolean;
    searchInDocuments: boolean;
    showConfig: boolean;
    sidebarLinks: ManuallyValidatedOption<Record<string, string>>;
    skipErrorChecking: boolean;
    sluggerConfiguration: { lowercase: boolean };
    sort: (
        | "kind"
        | "source-order"
        | "alphabetical"
        | "alphabetical-ignoring-documents"
        | "enum-value-ascending"
        | "enum-value-descending"
        | "enum-member-source-order"
        | "static-first"
        | "instance-first"
        | "visibility"
        | "required-first"
        | "external-last"
        | "documents-first"
        | "documents-last"
    )[];
    sortEntryPoints: boolean;
    sourceLinkExternal: boolean;
    sourceLinkTemplate: string;
    suppressCommentWarningsInDeclarationFiles: boolean;
    theme: string;
    titleLink: string;
    treatValidationWarningsAsErrors: boolean;
    treatWarningsAsErrors: boolean;
    tsconfig: NormalizedPath;
    typePrintWidth: number;
    useFirstParagraphOfCommentAsSummary: boolean;
    useHostedBaseUrlForAbsoluteLinks: boolean;
    useTsLinkResolution: boolean;
    validation: ValidationOptions;
    version: boolean;
    visibilityFilters: {
        external?: boolean;
        inherited?: boolean;
        private?: boolean;
        protected?: boolean;
        [tag: `@${string}`]: boolean;
    };
    watch: boolean;
}

// typedoc.config.mjs
import iterator from "markdown-it-for-inline";
export default {
    /** @param {MarkdownIt} parser */
    markdownItLoader(parser) {
        parser.use(iterator, "foo_replace", "text", function(tokens, idx) {
            tokens[idx].content = tokens[idx].content.replace(/foo/g, 'bar');
        });
    }
}
Copy