@canalplus/readme.doc/build/create_documentation.d.ts

Readme's an Extremely Accessible Documentation MakEr

/** Global JS configuration for README. */
export interface DocumentationCreationOptions {
    /** If `true`, we will remove the output directory first. */
    clean?: boolean;
    /** Set to the project's version linked to your documentation. */
    version?: string | undefined;
}
/**
 * Create documentation for the directory given into the ouput directory given.
 * @param {string} baseInDir - The input directory where markdown documentation
 * is read.
 * @param {string} baseOutDir - The output directory where HTML files are
 * generated.
 * @param {Object} [options={}] - Various documentation options.
 * @param {Function} [options.getPageTitle] - Callback returning the name of the
 * page, based on the name of a single markdown document.
 * If not set, the page title will just be the corresponding markdown's title.
 * @param {Array.<string>} [options.css] - Optional CSS files which will be
 * linked to each generated page.
 * Should be the path to each of those.
 * @param {string|undefined} [options.version] - String indicating the current
 * version of the documented application.
 * @returns {Promise} - Resolve when done
 */
export default function createDocumentation(baseInDir: string, baseOutDir: string, options?: DocumentationCreationOptions): Promise<void>;