summaryrefslogtreecommitdiff
path: root/themes/blowfish/assets/lib/mermaid/diagram-api/frontmatter.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'themes/blowfish/assets/lib/mermaid/diagram-api/frontmatter.d.ts')
-rw-r--r--themes/blowfish/assets/lib/mermaid/diagram-api/frontmatter.d.ts18
1 files changed, 18 insertions, 0 deletions
diff --git a/themes/blowfish/assets/lib/mermaid/diagram-api/frontmatter.d.ts b/themes/blowfish/assets/lib/mermaid/diagram-api/frontmatter.d.ts
new file mode 100644
index 0000000..e62a4ba
--- /dev/null
+++ b/themes/blowfish/assets/lib/mermaid/diagram-api/frontmatter.d.ts
@@ -0,0 +1,18 @@
+import type { MermaidConfig } from '../config.type.js';
+interface FrontMatterMetadata {
+ title?: string;
+ displayMode?: string;
+ 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 {};