package.dist.diagram-api.frontmatter.d.ts Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mermaid Show documentation

Markdown-ish syntax for generating flowcharts, mindmaps, sequence diagrams, class diagrams, gantt charts, git graphs and more.

There is a newer version: 11.4.0

Show newest version

import type { GanttDiagramConfig, MermaidConfig } from '../config.type.js';
interface FrontMatterMetadata {
    title?: string;
    displayMode?: GanttDiagramConfig['displayMode'];
    config?: MermaidConfig;
}
export interface FrontMatterResult {
    text: string;
    metadata: FrontMatterMetadata;
}
/**
 * Extract and parse frontmatter from text, if present, and sets appropriate
 * properties in the provided db.
 * @param text - The text that may have a YAML frontmatter.
 * @returns text with frontmatter stripped out
 */
export declare function extractFrontMatter(text: string): FrontMatterResult;
export {};