jsii-docgen/lib/docgen/view/readme.d.ts

generates api docs for jsii modules

import * as reflect from 'jsii-reflect';
import { MarkdownDocument } from '../render/markdown-doc';
import { Transpile } from '../transpile/transpile';
/**
 * Render the user defined readme of a jsii library.
 */
export declare class Readme {
    private readonly readme?;
    constructor(transpile: Transpile, assembly: reflect.Assembly, submodule?: reflect.Submodule);
    /**
     * Generate markdown.
     */
    render(): MarkdownDocument;
}