course-renderer/dist/course-renderer.d.ts

Manages CA School Courses file system storage and HTML conversion

/**
 * Renders a course chapter file.
 *
 * @param sourceFile path to the source file to be rendered.
 * @param cb callback to be called when the rendering is done.
 *          Accepts two argument, the error and the rendered string.
 */
export declare function renderChapter(sourceFile: string, cb: any): void;
/** TODO There's too much code duplicate on this module. */
/**
 * Renders the course content ONLY, this is mostly use by the validator. Since the validator only concern is the course content directory and the summary.md file
 *
 * @param source path to the directory where all course raw directory are stored
 * @param dest path to the directory where all course rendered directory are stored
 * @param course the name of the course to be rendered
 * @param silent if we're on silent mode. This will suppress output.
 * @param cb callback when the rendering is done or if an error occur.
 */
export declare function renderCourseContent(source: string, dest: string, course: string, silent: boolean, cb: any): void;
export declare function customRender(target: string, extension: any, silent: boolean, cb: any): void;
/**
 * Renders a course and save it to a destination path.
 *
 * @param source path to the directory where all course raw directory are stored
 * @param dest path to the directory where all course rendered directory are stored
 * @param course the name of the course to be rendered
 * @param silent if we're on silent mode. This will suppress output.
 * @param cb callback when the rendering is done or if an error occur.
 */
export declare function render(source: string, dest: string, course: string, silent: boolean, cb: any): void;