myst-cli
Version:
Command line tools for MyST
26 lines • 1.29 kB
TypeScript
import type { SiteAction, SiteExport, SiteManifest } from 'myst-config';
import type { ISession } from '../../session/types.js';
import type { ManifestProject } from '../utils/projectManifest.js';
export declare function resolvePageExports(session: ISession, file: string): Promise<SiteExport[]>;
export declare function resolvePageDownloads(session: ISession, file: string, projectPath?: string): Promise<SiteAction[] | undefined>;
/**
* Convert local project representation to site manifest project
*
* This does a couple things:
* - Adds projectSlug (which locally comes from site config)
* - Removes any local file references
* - Adds validated frontmatter
* - Writes and transforms banner and thumbnail images
*/
export declare function localToManifestProject(session: ISession, projectPath?: string, projectSlug?: string): Promise<ManifestProject | null>;
export type SiteManifestOptions = {
defaultTemplate?: string;
};
/**
* Build site manifest from local redux state
*
* Site manifest acts as the configuration to build the website.
* It combines local site config and project configs into a single structure.
*/
export declare function getSiteManifest(session: ISession, opts?: SiteManifestOptions): Promise<SiteManifest>;
//# sourceMappingURL=manifest.d.ts.map