vitepress-jsdoc/dist/commonjs/utilities/create-readme.d.ts

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

import { type PluginOptions } from '../interfaces.js';
/**
 * Creates or updates the README file for the documentation. If a custom README file is provided,
 * its content will be used; otherwise, a default welcome message will be written.
 *
 * @function
 * @async
 *
 * @param {PluginOptions} options - The plugin options providing configuration for the README creation.
 * @param {string[]} [deletedPaths] - An optional list of paths that were deleted. Used to check if the README was among them.
 *
 * @returns {Promise<void>} A promise that resolves when the README file has been successfully created or updated.
 *
 * @throws Will throw an error if there's an issue reading from or writing to the file system.
 *
 * @example
 *
 * const options = {
 *   srcFolder: './src',
 *   codeFolder: 'code',
 *   docsFolder: './docs',
 *   title: 'My Documentation',
 *   readme: './src/README.md'
 * };
 *
 * createReadmeFile(options);
 */
export declare const createReadmeFile: (options: PluginOptions, deletedPaths?: string[]) => Promise<void>;
//# sourceMappingURL=create-readme.d.ts.map