myst-cli/dist/utils/fileInfo.d.ts

Command line tools for MyST

import type { PageSlugs } from '../project/types.js';
import type { ISession } from '../session/types.js';
export declare function createSlug(s: string): string;
export declare function createTitle(s: string): string;
export declare function fileTitle(file: string): string;
/**
 * Create a unique slug for a file
 *
 * If opts.urlFolders is true and opts.projectPath is provided, slug will include folders
 */
export declare function fileInfo(file: string, pageSlugs: PageSlugs, opts?: {
    session?: ISession;
    projectPath?: string;
    urlFolders?: boolean;
}): {
    slug: string;
    title: string;
};
//# sourceMappingURL=fileInfo.d.ts.map