myst-cli
Version:
Command line tools for MyST
15 lines • 689 B
TypeScript
import type { PageFrontmatter } from 'myst-frontmatter';
import type { ISession } from '../session/types.js';
/**
* Auto-generate edit_url and source_url for a page based on its GitHub repo.
*
* These URLs let readers view or propose edits to the source file:
* - source_url: links to /blob/ (read-only view)
* - edit_url: links to /edit/ (GitHub's web editor)
*
* Users can override by setting these in frontmatter:
* - Set to a string: use that URL instead
* - Set to null: disable the URL entirely (won't be generated)
*/
export declare function addEditUrl(session: ISession, frontmatter: PageFrontmatter, file: string): Promise<void>;
//# sourceMappingURL=addEditUrl.d.ts.map