import type { Node } from "./builder"; /** * Range of lines to include * @category Builder types * * @since 1.0.0 * @author Simon Kovtyk */ type Range = { /** * Starting line of the range * * @since 1.0.0 * @author Simon Kovtyk */ from?: number; /** * Ending line of the range * * @since 1.0.0 * @author Simon Kovtyk */ to?: number; }; /** * Options for the include directive * @category Builder types * * @since 1.0.0 * @author Simon Kovtyk */ type Options = { /** * Range of lines to include * * @since 1.0.0 * @author Simon Kovtyk */ range?: Range; /** * Section to include * * @since 1.0.0 * @author Simon Kovtyk */ section?: string; }; /** * Builder-element for an include directive * @param path - Path to the file to include * @param options - Options for the include directive * @returns A markdown node * @category Builder * @example * ```ts * import { define, include } from "@ogs-gmbh/markdown"; * * const markdown = define( * include("path/to/file.md", { range: { from: 5, to: 10 } }) * ); * * console.assert( * markdown.toString() * ); * ``` * * @see https://vitepress.dev/guide/markdown#markdown-file-inclusion * @since 1.0.0 * @author Simon Kovtyk */ declare function include(path: string, options?: Options): Node; export type { Range as IncludeRange, Options as IncludeOptions }; export { include }; //# sourceMappingURL=include.d.ts.map