node-scripts-docs/output/DocumentationRenderer.d.ts

Generate documentation for your `package.json` scripts.

import { ScriptStore } from "./ScriptStore.js";
/**
 * Renders an entire script store as a single Markdown document.
 */
export declare class DocumentationRenderer {
    private metadata;
    /**
     * Constructs a new documentation renderer.
     * @param metadata - The script metadata to render.
     */
    constructor(metadata: ScriptStore);
    /**
     * Render the documentation.
     * @param includeLocalScripts - Should project-local scripts be rendered?
     * @returns The final Markdown document.
     */
    render(includeLocalScripts?: boolean): string;
    /**
     * Write individual documentation fragments to disc.
     * @param rootDirectory - The directory to write the fragments to.
     * @param includeLocalScripts - Should project-local scripts be included?
     */
    flushFragments(rootDirectory: string, includeLocalScripts?: boolean): Promise<void>;
}
//# sourceMappingURL=DocumentationRenderer.d.ts.map