UNPKG

@mdfriday/foundry

Version:

The core engine of MDFriday. Convert Markdown and shortcodes into fully themed static sites – Hugo-style, powered by TypeScript.

139 lines 3.07 kB
/** * Auto heading ID types */ export declare const AutoHeadingIDType: { readonly GitHub: "github"; readonly GitHubAscii: "github-ascii"; readonly Blackfriday: "blackfriday"; }; export type AutoHeadingIDType = typeof AutoHeadingIDType[keyof typeof AutoHeadingIDType]; /** * Typographer configuration */ export interface TypographerConfig { disable: boolean; leftSingleQuote: string; rightSingleQuote: string; leftDoubleQuote: string; rightDoubleQuote: string; enDash: string; emDash: string; ellipsis: string; leftAngleQuote: string; rightAngleQuote: string; apostrophe: string; } /** * CJK configuration */ export interface CJKConfig { enable: boolean; eastAsianLineBreaks: boolean; eastAsianLineBreaksStyle: string; escapedSpace: boolean; } /** * Delimiters configuration */ export interface DelimitersConfig { inline: string[][]; block: string[][]; } /** * Passthrough configuration */ export interface PassthroughConfig { enable: boolean; delimiters: DelimitersConfig; } /** * Highlight configuration */ export interface HighlightConfig { style: string; lineNos: boolean; lineNoStart: number; anchorLineNos: boolean; lineAnchors: string; lineNumbersInTable: boolean; noClasses: boolean; codeFences: boolean; guessSyntax: boolean; tabWidth: number; } /** * Parser attribute configuration */ export interface ParserAttributeConfig { title: boolean; block: boolean; } /** * Parser configuration */ export interface ParserConfig { autoHeadingID: boolean; autoHeadingIDType: AutoHeadingIDType; wrapStandAloneImageWithinParagraph: boolean; attribute: ParserAttributeConfig; } /** * Renderer configuration */ export interface RendererConfig { unsafe: boolean; } /** * Extensions configuration */ export interface ExtensionsConfig { typographer: TypographerConfig; footnote: boolean; definitionList: boolean; table: boolean; strikethrough: boolean; linkify: boolean; linkifyProtocol: string; taskList: boolean; cjk: CJKConfig; passthrough: PassthroughConfig; highlight: HighlightConfig; } /** * Image render hook configuration */ export interface ImageRenderHookConfig { enableDefault: boolean; } /** * Link render hook configuration */ export interface LinkRenderHookConfig { enableDefault: boolean; } /** * Render hooks configuration */ export interface RenderHooksConfig { image: ImageRenderHookConfig; link: LinkRenderHookConfig; } /** * Main Markdown configuration */ export interface DomainMarkdownConfig { renderer: RendererConfig; parser: ParserConfig; extensions: ExtensionsConfig; duplicateResourceFiles: boolean; renderHooks: RenderHooksConfig; } /** * Default highlight configuration */ export declare const DefaultHighlightConfig: HighlightConfig; /** * Default markdown configuration */ export declare const DefaultMarkdownConfig: DomainMarkdownConfig; //# sourceMappingURL=config.d.ts.map