vitepress-jsdoc/dist/esm/index.d.ts

A bridge between Vitepress and JSDoc-style commented codebases for hassle-free documentation.

import { type PluginOptions } from './interfaces.js';
/**
 * ## Generate Markdown Files
 * Orchestrates the process of reading, filtering, and writing files.
 *
 * - **options**: The plugin options of type `PluginOptions`.
 *
 * @example
 * ```typescript
 * generate(myCliArgs);
 * ```
 */
export declare const generate: (options: PluginOptions) => Promise<void>;
/**
 * Vitepress JSDoc Plugin.
 *
 * @function
 * @param {PluginOptions} options - The options for the plugin.
 * @returns {Plugin} Returns a Vite plugin object.
 *
 * @example
 * ```typescript
 * // Example Vitepress Configuration
 * import { defineConfig } from "vitepress";
 * import VitpressJsdocPlugin from "vitepress-jsdoc";
 *
 * export default defineConfig({
 *   vite: {
 *     plugins: [
 *       VitpressJsdocPlugin({
 *         folder: "code",
 *         source: "./dist/mjs/",
 *         dist: "./docs",
 *         title: "API",
 *         partials: ["./dist/mjs/partials/*.hbs"],
 *         helpers: ["./dist/mjs/helpers/*.js"],
 *         readme: "./README.md",
 *         exclude: "**\/*.json,**\/*.hbs,**\/*.d.js,**\/*.map,**\/interfaces.*",
 *       }),
 *     ],
 *   },
 * });
 * ```
 */
declare const plugin: (options: PluginOptions) => {
    name: string;
    configureServer(server: any): void;
};
export default plugin;
//# sourceMappingURL=index.d.ts.map