@dskripchenko/ui 1.26.1 → 1.28.0

package/dist/components/Markdown/index.d.ts

@@ -1,6 +1,6 @@
 export { default as UidMarkdown } from './UidMarkdown.vue';
 export type { UidMarkdownProps } from './UidMarkdown.vue';
-export { createSlugger, escapeHtml, renderMarkdown, resolveAgainst, splitMarkdown, } from './markdown.js';
-export type { MarkdownHeading, MarkdownOptions, MarkdownSegment, Slugger, UidMarkdownCalloutKind, } from './markdown.js';
+export { createSlugger, escapeHtml, readFrontMatter, renderMarkdown, resolveAgainst, splitMarkdown, } from './markdown.js';
+export type { FrontMatter, FrontMatterValue, MarkdownHeading, MarkdownOptions, MarkdownSegment, Slugger, UidMarkdownCalloutKind, } from './markdown.js';
 export { markdownBlockRenderersKey, provideMarkdownBlockRenderers, useMarkdownBlockRenderers, } from './blockRenderers.js';
 export type { UidMarkdownBlockRenderer, UidMarkdownBlockRenderContext, UidMarkdownBlockRenderers, UidMarkdownBlockResult, UidMarkdownBlockMountContext, UidMarkdownBlockMountHandle, } from './blockRenderers.js';

package/dist/components/Markdown/markdown.d.ts

@@ -21,13 +21,24 @@ export interface MarkdownOptions {
     linkBase?: string | null;
     /** Drops a trailing `.md` from relative links resolved through linkBase. */
     stripMdExtension?: boolean;
-    /** Reads `[[note]]` internal links (on by default): links with `data-wikilink` for the host to resolve. */
+    /**
+     * Reads `[[note]]` internal links (on by default): links with `data-wikilink` for the host to resolve;
+     * `![[note]]` is an embed — `<span class="uid-markdown__embed" data-embed>` around the link, for the host to fill.
+     */
     wikiLinks?: boolean;
     /**
      * Reads TeX math (on by default): `$…$` and `\(…\)` in a line, `$$…$$` and
      * `\[…\]` on lines of their own — drawn as MathML by @dskripchenko/math.
      */
     math?: boolean;
+    /** Reads `#tags` (on by default): `<span class="uid-markdown__tag" data-tag="…">` for the host to act on. */
+    tags?: boolean;
+    /**
+     * Reads a YAML front matter at the start of the source (`---` lines around
+     * `key: value`) as the document's properties, drawn as a table. Off by
+     * default: a caller rendering a piece of a document says when it is the start.
+     */
+    frontMatter?: boolean;
     /** The base relative image paths resolve against. */
     imageBase?: string | null;
     /**
@@ -50,6 +61,20 @@ export type UidMarkdownCalloutKind = 'note' | 'tip' | 'important' | 'warning' |
  * again; an absolute base keeps its origin, a path base yields a path.
  */
 export declare function resolveAgainst(escapedUrl: string, base: string, stripMd?: boolean): string;
+/** A value of a document's property: text, or a list. */
+export type FrontMatterValue = string | string[];
+/** A document's YAML front matter: its properties, and how long it is in the source. */
+export interface FrontMatter {
+    data: Record<string, FrontMatterValue>;
+    /** The characters it takes at the start of the source, its `---` lines included. */
+    length: number;
+}
+/**
+ * The front matter at the start of a source, read as simple YAML: `key: value`,
+ * lists as `[a, b]` or `- a` lines, quoted strings; anything deeper is kept as
+ * its text. Null when the source does not start with one.
+ */
+export declare function readFrontMatter(source: string): FrontMatter | null;
 export declare function renderMarkdown(source: string | null | undefined, opts?: MarkdownOptions): string;
 /** A piece of a markdown document: text to render, or a top-level fenced code block. */
 export type MarkdownSegment = {