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

Command line tools for MyST

import type { PageFrontmatter } from 'myst-frontmatter';
import type { ISession } from '../session/types.js';
/**
 * Compute edit_url and add to frontmatter
 *
 * If edit_url is already defined on the page it will remain unchanged.
 * If edit_url is explicitly null or if github url is not defined, edit_url will not be set.
 * If git is not available to determine branch and top-level folder, edit_url will not be set.
 */
export declare function addEditUrl(session: ISession, frontmatter: PageFrontmatter, file: string): Promise<void>;
//# sourceMappingURL=addEditUrl.d.ts.map