vitepress-jsdoc
Version:
A bridge between Vitepress and JSDoc-style commented codebases for hassle-free documentation.
23 lines • 983 B
JavaScript
import { createReadmeFile } from '../utilities/create-readme.js';
/**
* The `ReadmeManager` class provides functionalities to manage the README file
* of the project. It offers methods to create or update the README based on
* the provided arguments and configurations.
*/
export class ReadmeManager {
/**
* Creates or updates the README file based on the provided arguments.
*
* @param {PluginOptions} options - Plugin options to guide the creation of the README.
* @param {string[]} deletedPaths - An array of paths that were deleted, to be documented in the README.
* @returns {Promise<void>} A promise that resolves once the README is created or updated.
*
* @example
* const readmeManager = new ReadmeManager();
* await readmeManager.create(cliArgs, deletedPathsArray);
*/
async create(options, deletedPaths) {
await createReadmeFile(options, deletedPaths);
}
}
//# sourceMappingURL=readme-manager.js.map