builddocs/dist/builddocs.d.ts

Generate HTML documentation from TypeScript types and doc comments

import { Module, Type } from "./getdocs.js";
export declare class BuildError extends Error {
}
export declare function resolveLink(project: readonly Module[], path: string, homemod?: string): {
    id: string;
    name: string;
} | null;
export declare function resolveLinks(project: readonly Module[], text: string, config?: {
    homemod?: string;
    warn?: (target: string) => void;
    prefix?: string;
}): string;
export type ModuleDocs = {
    modname?: string;
    filename: string;
    module: Module;
    text: string;
    mainFile: string;
};
export type BuildConfig = {
    modules: readonly ({
        filename: string;
        modname?: string;
    } | Module)[];
    renderMarkdown: (markdown: string) => string;
    maxCol?: number;
    resolveType?: (Record<string, string> | ((type: Type.Reference) => string | null))[];
};
export declare function buildDocs(conf: BuildConfig): ModuleDocs[];