myst-cli/dist/project/load.d.ts

Command line tools for MyST

import type { ISession } from '../session/types.js';
import type { LocalProject, LocalProjectPage } from './types.js';
/**
 * Load project structure from disk
 *
 * @param session session with logging
 * @param path root directory of project, relative to current directory
 * @param opts `index`, including path relative to current directory; default is 'index.md'
 *     or 'readme.md' in 'path' directory
 *
 * If JupyterBook '_toc.yml' exists in path, project structure will be derived from that.
 * In this case, index will be ignored in favor of root from '_toc.yml'
 * If '_toc.yml' does not exist, project structure will be built from the local file/folder structure.
 */
export declare function loadProjectFromDisk(session: ISession, path?: string, opts?: {
    index?: string;
    writeTOC?: boolean;
    warnOnNoConfig?: boolean;
    reloadProject?: boolean;
}): Promise<LocalProject>;
export declare function findProjectsOnPath(session: ISession, path: string): Promise<string[]>;
export declare function filterPages(project: LocalProject): LocalProjectPage[];
//# sourceMappingURL=load.d.ts.map