solidity-docgen/dist/sitemap.d.ts

Solidity API documentation automatic generator.

import { VFile } from './vfile';
import { Source, SourceContract, Linkable } from './source';
import { Page } from './page';
import { Filter } from './filter';
export declare const sitemapKinds: readonly ["contracts", "readmes", "single"];
export declare type SitemapKind = typeof sitemapKinds[number];
export interface Link {
    target: Linkable;
    path: string;
    relativePath: string;
}
export declare abstract class Sitemap {
    static generate(source: Source, filter: Filter, readmes: VFile[], ext: string, kind: SitemapKind): Sitemap;
    protected abstract source: Source;
    protected abstract filter: Filter;
    abstract pages: Page[];
    get contracts(): SourceContract[];
    links(origin: Page): Link[];
}
//# sourceMappingURL=sitemap.d.ts.map