@mdfriday/foundry
Version:
The core engine of MDFriday. Convert Markdown and shortcodes into fully themed static sites – Hugo-style, powered by TypeScript.
91 lines (90 loc) • 2.43 kB
TypeScript
export declare const AutoHeadingIDType: {
readonly GitHub: "github";
readonly GitHubAscii: "github-ascii";
readonly Blackfriday: "blackfriday";
};
export type AutoHeadingIDType = typeof AutoHeadingIDType[keyof typeof AutoHeadingIDType];
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;
}
export interface CJKConfig {
enable: boolean;
eastAsianLineBreaks: boolean;
eastAsianLineBreaksStyle: string;
escapedSpace: boolean;
}
export interface DelimitersConfig {
inline: string[][];
block: string[][];
}
export interface PassthroughConfig {
enable: boolean;
delimiters: DelimitersConfig;
}
export interface HighlightConfig {
style: string;
lineNos: boolean;
lineNoStart: number;
anchorLineNos: boolean;
lineAnchors: string;
lineNumbersInTable: boolean;
noClasses: boolean;
codeFences: boolean;
guessSyntax: boolean;
tabWidth: number;
}
export interface ParserAttributeConfig {
title: boolean;
block: boolean;
}
export interface ParserConfig {
autoHeadingID: boolean;
autoHeadingIDType: AutoHeadingIDType;
wrapStandAloneImageWithinParagraph: boolean;
attribute: ParserAttributeConfig;
}
export interface RendererConfig {
unsafe: boolean;
}
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;
}
export interface ImageRenderHookConfig {
enableDefault: boolean;
}
export interface LinkRenderHookConfig {
enableDefault: boolean;
}
export interface RenderHooksConfig {
image: ImageRenderHookConfig;
link: LinkRenderHookConfig;
}
export interface DomainMarkdownConfig {
renderer: RendererConfig;
parser: ParserConfig;
extensions: ExtensionsConfig;
duplicateResourceFiles: boolean;
renderHooks: RenderHooksConfig;
}
export declare const DefaultHighlightConfig: HighlightConfig;
export declare const DefaultMarkdownConfig: DomainMarkdownConfig;