remark-api/lib/index.d.ts

remark plugin to generate an API section

/**
 * Generate an API section.
 *
 * Looks for the closest `package.json` file upwards from the current
 * markdown file.
 * For each export in the package, it generates API docs.
 * It injects those into an `# API` section.
 *
 * @returns
 *   Transform.
 */
export default function remarkApi(): (tree: Root, file: VFile) => Promise<undefined>;
export type Root = import('mdast').Root;
export type RootContent = import('mdast').RootContent;
export type Position = import('unist').Position;
export type VFile = import('vfile').VFile;
export type VFileMessage = import('vfile-message').VFileMessage;
//# sourceMappingURL=index.d.ts.map