vantage-md 0.6.1 → 0.7.0

package/dist/index.d.ts

@@ -1,10 +1,1038 @@
 import { PluggableList, Plugin } from "unified";
 import { defaultSchema } from "rehype-sanitize";
-//#region src/renderMarkdown.d.ts
+//#region ../../node_modules/@types/unist/index.d.ts
+// ## Interfaces
+/**
+ * Info associated with nodes by the ecosystem.
+ *
+ * This space is guaranteed to never be specified by unist or specifications
+ * implementing unist.
+ * But you can use it in utilities and plugins to store data.
+ *
+ * This type can be augmented to register custom data.
+ * For example:
+ *
+ * ```ts
+ * declare module 'unist' {
+ *   interface Data {
+ *     // `someNode.data.myId` is typed as `number | undefined`
+ *     myId?: number | undefined
+ *   }
+ * }
+ * ```
+ */
+interface Data$2 {}
+/**
+ * One place in a source file.
+ */
+interface Point {
+  /**
+   * Line in a source file (1-indexed integer).
+   */
+  line: number;
+  /**
+   * Column in a source file (1-indexed integer).
+   */
+  column: number;
+  /**
+   * Character in a source file (0-indexed integer).
+   */
+  offset?: number | undefined;
+}
+/**
+ * Position of a node in a source document.
+ *
+ * A position is a range between two points.
+ */
+interface Position {
+  /**
+   * Place of the first character of the parsed source region.
+   */
+  start: Point;
+  /**
+   * Place of the first character after the parsed source region.
+   */
+  end: Point;
+}
+/**
+ * Abstract unist node.
+ *
+ * The syntactic unit in unist syntax trees are called nodes.
+ *
+ * This interface is supposed to be extended.
+ * If you can use {@link Literal} or {@link Parent}, you should.
+ * But for example in markdown, a `thematicBreak` (`***`), is neither literal
+ * nor parent, but still a node.
+ */
+interface Node$2 {
+  /**
+   * Node type.
+   */
+  type: string;
+  /**
+   * Info from the ecosystem.
+   */
+  data?: Data$2 | undefined;
+  /**
+   * Position of a node in a source document.
+   *
+   * Nodes that are generated (not in the original source document) must not
+   * have a position.
+   */
+  position?: Position | undefined;
+}
+//#endregion
+//#region ../../node_modules/@types/mdast/index.d.ts
+// ## Enumeration
+/**
+ * How phrasing content is aligned
+ * ({@link https://drafts.csswg.org/css-text/ | [CSSTEXT]}).
+ *
+ * * `'left'`: See the
+ *   {@link https://drafts.csswg.org/css-text/#valdef-text-align-left | left}
+ *   value of the `text-align` CSS property
+ * * `'right'`: See the
+ *   {@link https://drafts.csswg.org/css-text/#valdef-text-align-right | right}
+ *   value of the `text-align` CSS property
+ * * `'center'`: See the
+ *   {@link https://drafts.csswg.org/css-text/#valdef-text-align-center | center}
+ *   value of the `text-align` CSS property
+ * * `null`: phrasing content is aligned as defined by the host environment
+ *
+ * Used in GFM tables.
+ */
+type AlignType = "center" | "left" | "right" | null;
+/**
+ * Explicitness of a reference.
+ *
+ * `'shortcut'`: the reference is implicit, its identifier inferred from its
+ *   content
+ * `'collapsed'`: the reference is explicit, its identifier inferred from its
+ *   content
+ * `'full'`: the reference is explicit, its identifier explicitly set
+ */
+type ReferenceType = "shortcut" | "collapsed" | "full";
+// ## Mixin
+/**
+ * Node with a fallback.
+ */
+interface Alternative {
+  /**
+   * Equivalent content for environments that cannot represent the node as
+   * intended.
+   */
+  alt?: string | null | undefined;
+}
+/**
+ * Internal relation from one node to another.
+ *
+ * Whether the value of `identifier` is expected to be a unique identifier or
+ * not depends on the type of node including the Association.
+ * An example of this is that they should be unique on {@link Definition},
+ * whereas multiple {@link LinkReference}s can be non-unique to be associated
+ * with one definition.
+ */
+interface Association {
+  /**
+   * Relation of association.
+   *
+   * `identifier` is a source value: character escapes and character
+   * references are not parsed.
+   *
+   * It can match another node.
+   *
+   * Its value must be normalized.
+   * To normalize a value, collapse markdown whitespace (`[\t\n\r ]+`) to a space,
+   * trim the optional initial and/or final space, and perform Unicode-aware
+   * case-folding.
+   */
+  identifier: string;
+  /**
+   * Relation of association, in parsed form.
+   *
+   * `label` is a `string` value: it works just like `title` on {@link Link}
+   * or a `lang` on {@link Code}: character escapes and character references
+   * are parsed.
+   *
+   * It can match another node.
+   */
+  label?: string | null | undefined;
+}
+/**
+ * Marker that is associated to another node.
+ */
+interface Reference extends Association {
+  /**
+   * Explicitness of the reference.
+   */
+  referenceType: ReferenceType;
+}
+/**
+ * Reference to resource.
+ */
+interface Resource {
+  /**
+   * URL to the referenced resource.
+   */
+  url: string;
+  /**
+   * Advisory information for the resource, such as would be appropriate for
+   * a tooltip.
+   */
+  title?: string | null | undefined;
+}
+// ## Interfaces
+/**
+ * Info associated with mdast nodes by the ecosystem.
+ *
+ * This space is guaranteed to never be specified by unist or mdast.
+ * But you can use it in utilities and plugins to store data.
+ *
+ * This type can be augmented to register custom data.
+ * For example:
+ *
+ * ```ts
+ * declare module 'mdast' {
+ *   interface Data {
+ *     // `someNode.data.myId` is typed as `number | undefined`
+ *     myId?: number | undefined
+ *   }
+ * }
+ * ```
+ */
+interface Data$1 extends Data$2 {}
+// ## Content maps
+/**
+ * Union of registered mdast nodes that can occur where block content is
+ * expected.
+ *
+ * To register custom mdast nodes, add them to {@link BlockContentMap}.
+ * They will be automatically added here.
+ */
+type BlockContent = BlockContentMap[keyof BlockContentMap];
+/**
+ * Registry of all mdast nodes that can occur where {@link BlockContent} is
+ * expected.
+ *
+ * This interface can be augmented to register custom node types:
+ *
+ * ```ts
+ * declare module 'mdast' {
+ *   interface BlockContentMap {
+ *     // Allow using MDX ESM nodes defined by `remark-mdx`.
+ *     mdxjsEsm: MdxjsEsm;
+ *   }
+ * }
+ * ```
+ *
+ * For a union of all block content, see {@link RootContent}.
+ */
+interface BlockContentMap {
+  blockquote: Blockquote;
+  code: Code;
+  heading: Heading;
+  html: Html;
+  list: List;
+  paragraph: Paragraph;
+  table: Table;
+  thematicBreak: ThematicBreak;
+}
+/**
+ * Union of registered mdast nodes that can occur where definition content is
+ * expected.
+ *
+ * To register custom mdast nodes, add them to {@link DefinitionContentMap}.
+ * They will be automatically added here.
+ */
+type DefinitionContent = DefinitionContentMap[keyof DefinitionContentMap];
+/**
+ * Registry of all mdast nodes that can occur where {@link DefinitionContent}
+ * is expected.
+ *
+ * This interface can be augmented to register custom node types:
+ *
+ * ```ts
+ * declare module 'mdast' {
+ *   interface DefinitionContentMap {
+ *     custom: Custom;
+ *   }
+ * }
+ * ```
+ *
+ * For a union of all definition content, see {@link RootContent}.
+ */
+interface DefinitionContentMap {
+  definition: Definition;
+  footnoteDefinition: FootnoteDefinition;
+}
+/**
+ * Union of registered mdast nodes that can occur where list content is
+ * expected.
+ *
+ * To register custom mdast nodes, add them to {@link ListContentMap}.
+ * They will be automatically added here.
+ */
+type ListContent = ListContentMap[keyof ListContentMap];
+/**
+ * Registry of all mdast nodes that can occur where {@link ListContent}
+ * is expected.
+ *
+ * This interface can be augmented to register custom node types:
+ *
+ * ```ts
+ * declare module 'mdast' {
+ *   interface ListContentMap {
+ *     custom: Custom;
+ *   }
+ * }
+ * ```
+ *
+ * For a union of all list content, see {@link RootContent}.
+ */
+interface ListContentMap {
+  listItem: ListItem;
+}
+/**
+ * Union of registered mdast nodes that can occur where phrasing content is
+ * expected.
+ *
+ * To register custom mdast nodes, add them to {@link PhrasingContentMap}.
+ * They will be automatically added here.
+ */
+type PhrasingContent = PhrasingContentMap[keyof PhrasingContentMap];
+/**
+ * Registry of all mdast nodes that can occur where {@link PhrasingContent}
+ * is expected.
+ *
+ * This interface can be augmented to register custom node types:
+ *
+ * ```ts
+ * declare module 'mdast' {
+ *   interface PhrasingContentMap {
+ *     // Allow using MDX JSX (text) nodes defined by `remark-mdx`.
+ *     mdxJsxTextElement: MDXJSXTextElement;
+ *   }
+ * }
+ * ```
+ *
+ * For a union of all phrasing content, see {@link RootContent}.
+ */
+interface PhrasingContentMap {
+  break: Break;
+  delete: Delete;
+  emphasis: Emphasis;
+  footnoteReference: FootnoteReference;
+  html: Html;
+  image: Image;
+  imageReference: ImageReference;
+  inlineCode: InlineCode;
+  link: Link;
+  linkReference: LinkReference;
+  strong: Strong;
+  text: Text$1;
+}
+/**
+ * Union of registered mdast nodes that can occur in {@link Root}.
+ *
+ * To register custom mdast nodes, add them to {@link RootContentMap}.
+ * They will be automatically added here.
+ */
+type RootContent$1 = RootContentMap$1[keyof RootContentMap$1];
+/**
+ * Registry of all mdast nodes that can occur as children of {@link Root}.
+ *
+ * > **Note**: {@link Root} does not need to be an entire document.
+ * > it can also be a fragment.
+ *
+ * This interface can be augmented to register custom node types:
+ *
+ * ```ts
+ * declare module 'mdast' {
+ *   interface RootContentMap {
+ *     // Allow using toml nodes defined by `remark-frontmatter`.
+ *     toml: TOML;
+ *   }
+ * }
+ * ```
+ *
+ * For a union of all {@link Root} children, see {@link RootContent}.
+ */
+interface RootContentMap$1 {
+  blockquote: Blockquote;
+  break: Break;
+  code: Code;
+  definition: Definition;
+  delete: Delete;
+  emphasis: Emphasis;
+  footnoteDefinition: FootnoteDefinition;
+  footnoteReference: FootnoteReference;
+  heading: Heading;
+  html: Html;
+  image: Image;
+  imageReference: ImageReference;
+  inlineCode: InlineCode;
+  link: Link;
+  linkReference: LinkReference;
+  list: List;
+  listItem: ListItem;
+  paragraph: Paragraph;
+  strong: Strong;
+  table: Table;
+  tableCell: TableCell;
+  tableRow: TableRow;
+  text: Text$1;
+  thematicBreak: ThematicBreak;
+  yaml: Yaml;
+}
+/**
+ * Union of registered mdast nodes that can occur where row content is
+ * expected.
+ *
+ * To register custom mdast nodes, add them to {@link RowContentMap}.
+ * They will be automatically added here.
+ */
+type RowContent = RowContentMap[keyof RowContentMap];
+/**
+ * Registry of all mdast nodes that can occur where {@link RowContent}
+ * is expected.
+ *
+ * This interface can be augmented to register custom node types:
+ *
+ * ```ts
+ * declare module 'mdast' {
+ *   interface RowContentMap {
+ *     custom: Custom;
+ *   }
+ * }
+ * ```
+ *
+ * For a union of all row content, see {@link RootContent}.
+ */
+interface RowContentMap {
+  tableCell: TableCell;
+}
+/**
+ * Union of registered mdast nodes that can occur where table content is
+ * expected.
+ *
+ * To register custom mdast nodes, add them to {@link TableContentMap}.
+ * They will be automatically added here.
+ */
+type TableContent = TableContentMap[keyof TableContentMap];
+/**
+ * Registry of all mdast nodes that can occur where {@link TableContent}
+ * is expected.
+ *
+ * This interface can be augmented to register custom node types:
+ *
+ * ```ts
+ * declare module 'mdast' {
+ *   interface TableContentMap {
+ *     custom: Custom;
+ *   }
+ * }
+ * ```
+ *
+ * For a union of all table content, see {@link RootContent}.
+ */
+interface TableContentMap {
+  tableRow: TableRow;
+}
+// ## Abstract nodes
+/**
+ * Abstract mdast node that contains the smallest possible value.
+ *
+ * This interface is supposed to be extended if you make custom mdast nodes.
+ *
+ * For a union of all registered mdast literals, see {@link Literals}.
+ */
+interface Literal$1 extends Node$1 {
+  /**
+   * Plain-text value.
+   */
+  value: string;
+}
+/**
+ * Abstract mdast node.
+ *
+ * This interface is supposed to be extended.
+ * If you can use {@link Literal} or {@link Parent}, you should.
+ * But for example in markdown, a thematic break (`***`) is neither literal nor
+ * parent, but still a node.
+ *
+ * To register custom mdast nodes, add them to {@link RootContentMap} and other
+ * places where relevant (such as {@link ElementContentMap}).
+ *
+ * For a union of all registered mdast nodes, see {@link Nodes}.
+ */
+interface Node$1 extends Node$2 {
+  /**
+   * Info from the ecosystem.
+   */
+  data?: Data$1 | undefined;
+}
+/**
+ * Abstract mdast node that contains other mdast nodes (*children*).
+ *
+ * This interface is supposed to be extended if you make custom mdast nodes.
+ *
+ * For a union of all registered mdast parents, see {@link Parents}.
+ */
+interface Parent$1 extends Node$1 {
+  /**
+   * List of children.
+   */
+  children: RootContent$1[];
+}
+// ## Concrete nodes
+/**
+ * Markdown block quote.
+ */
+interface Blockquote extends Parent$1 {
+  /**
+   * Node type of mdast block quote.
+   */
+  type: "blockquote";
+  /**
+   * Children of block quote.
+   */
+  children: Array<BlockContent | DefinitionContent>;
+  /**
+   * Data associated with the mdast block quote.
+   */
+  data?: BlockquoteData | undefined;
+}
+/**
+ * Info associated with mdast block quote nodes by the ecosystem.
+ */
+interface BlockquoteData extends Data$1 {}
+/**
+ * Markdown break.
+ */
+interface Break extends Node$1 {
+  /**
+   * Node type of mdast break.
+   */
+  type: "break";
+  /**
+   * Data associated with the mdast break.
+   */
+  data?: BreakData | undefined;
+}
+/**
+ * Info associated with mdast break nodes by the ecosystem.
+ */
+interface BreakData extends Data$1 {}
+/**
+ * Markdown code (flow) (block).
+ */
+interface Code extends Literal$1 {
+  /**
+   * Node type of mdast code (flow).
+   */
+  type: "code";
+  /**
+   * Language of computer code being marked up.
+   */
+  lang?: string | null | undefined;
+  /**
+   * Custom information relating to the node.
+   *
+   * If the lang field is present, a meta field can be present.
+   */
+  meta?: string | null | undefined;
+  /**
+   * Data associated with the mdast code (flow).
+   */
+  data?: CodeData | undefined;
+}
+/**
+ * Info associated with mdast code (flow) (block) nodes by the ecosystem.
+ */
+interface CodeData extends Data$1 {}
+/**
+ * Markdown definition.
+ */
+interface Definition extends Node$1, Association, Resource {
+  /**
+   * Node type of mdast definition.
+   */
+  type: "definition";
+  /**
+   * Data associated with the mdast definition.
+   */
+  data?: DefinitionData | undefined;
+}
+/**
+ * Info associated with mdast definition nodes by the ecosystem.
+ */
+interface DefinitionData extends Data$1 {}
+/**
+ * Markdown GFM delete (strikethrough).
+ */
+interface Delete extends Parent$1 {
+  /**
+   * Node type of mdast GFM delete.
+   */
+  type: "delete";
+  /**
+   * Children of GFM delete.
+   */
+  children: PhrasingContent[];
+  /**
+   * Data associated with the mdast GFM delete.
+   */
+  data?: DeleteData | undefined;
+}
+/**
+ * Info associated with mdast GFM delete nodes by the ecosystem.
+ */
+interface DeleteData extends Data$1 {}
+/**
+ * Markdown emphasis.
+ */
+interface Emphasis extends Parent$1 {
+  /**
+   * Node type of mdast emphasis.
+   */
+  type: "emphasis";
+  /**
+   * Children of emphasis.
+   */
+  children: PhrasingContent[];
+  /**
+   * Data associated with the mdast emphasis.
+   */
+  data?: EmphasisData | undefined;
+}
+/**
+ * Info associated with mdast emphasis nodes by the ecosystem.
+ */
+interface EmphasisData extends Data$1 {}
+/**
+ * Markdown GFM footnote definition.
+ */
+interface FootnoteDefinition extends Parent$1, Association {
+  /**
+   * Node type of mdast GFM footnote definition.
+   */
+  type: "footnoteDefinition";
+  /**
+   * Children of GFM footnote definition.
+   */
+  children: Array<BlockContent | DefinitionContent>;
+  /**
+   * Data associated with the mdast GFM footnote definition.
+   */
+  data?: FootnoteDefinitionData | undefined;
+}
+/**
+ * Info associated with mdast GFM footnote definition nodes by the ecosystem.
+ */
+interface FootnoteDefinitionData extends Data$1 {}
+/**
+ * Markdown GFM footnote reference.
+ */
+interface FootnoteReference extends Association, Node$1 {
+  /**
+   * Node type of mdast GFM footnote reference.
+   */
+  type: "footnoteReference";
+  /**
+   * Data associated with the mdast GFM footnote reference.
+   */
+  data?: FootnoteReferenceData | undefined;
+}
+/**
+ * Info associated with mdast GFM footnote reference nodes by the ecosystem.
+ */
+interface FootnoteReferenceData extends Data$1 {}
+/**
+ * Markdown heading.
+ */
+interface Heading extends Parent$1 {
+  /**
+   * Node type of mdast heading.
+   */
+  type: "heading";
+  /**
+   * Heading rank.
+   *
+   * A value of `1` is said to be the highest rank and `6` the lowest.
+   */
+  depth: 1 | 2 | 3 | 4 | 5 | 6;
+  /**
+   * Children of heading.
+   */
+  children: PhrasingContent[];
+  /**
+   * Data associated with the mdast heading.
+   */
+  data?: HeadingData | undefined;
+}
+/**
+ * Info associated with mdast heading nodes by the ecosystem.
+ */
+interface HeadingData extends Data$1 {}
+/**
+ * Markdown HTML.
+ */
+interface Html extends Literal$1 {
+  /**
+   * Node type of mdast HTML.
+   */
+  type: "html";
+  /**
+   * Data associated with the mdast HTML.
+   */
+  data?: HtmlData | undefined;
+}
+/**
+ * Info associated with mdast HTML nodes by the ecosystem.
+ */
+interface HtmlData extends Data$1 {}
+/**
+ * Markdown image.
+ */
+interface Image extends Alternative, Node$1, Resource {
+  /**
+   * Node type of mdast image.
+   */
+  type: "image";
+  /**
+   * Data associated with the mdast image.
+   */
+  data?: ImageData | undefined;
+}
+/**
+ * Info associated with mdast image nodes by the ecosystem.
+ */
+interface ImageData extends Data$1 {}
+/**
+ * Markdown image reference.
+ */
+interface ImageReference extends Alternative, Node$1, Reference {
+  /**
+   * Node type of mdast image reference.
+   */
+  type: "imageReference";
+  /**
+   * Data associated with the mdast image reference.
+   */
+  data?: ImageReferenceData | undefined;
+}
+/**
+ * Info associated with mdast image reference nodes by the ecosystem.
+ */
+interface ImageReferenceData extends Data$1 {}
+/**
+ * Markdown code (text) (inline).
+ */
+interface InlineCode extends Literal$1 {
+  /**
+   * Node type of mdast code (text).
+   */
+  type: "inlineCode";
+  /**
+   * Data associated with the mdast code (text).
+   */
+  data?: InlineCodeData | undefined;
+}
+/**
+ * Info associated with mdast code (text) (inline) nodes by the ecosystem.
+ */
+interface InlineCodeData extends Data$1 {}
+/**
+ * Markdown link.
+ */
+interface Link extends Parent$1, Resource {
+  /**
+   * Node type of mdast link.
+   */
+  type: "link";
+  /**
+   * Children of link.
+   */
+  children: PhrasingContent[];
+  /**
+   * Data associated with the mdast link.
+   */
+  data?: LinkData | undefined;
+}
+/**
+ * Info associated with mdast link nodes by the ecosystem.
+ */
+interface LinkData extends Data$1 {}
+/**
+ * Markdown link reference.
+ */
+interface LinkReference extends Parent$1, Reference {
+  /**
+   * Node type of mdast link reference.
+   */
+  type: "linkReference";
+  /**
+   * Children of link reference.
+   */
+  children: PhrasingContent[];
+  /**
+   * Data associated with the mdast link reference.
+   */
+  data?: LinkReferenceData | undefined;
+}
+/**
+ * Info associated with mdast link reference nodes by the ecosystem.
+ */
+interface LinkReferenceData extends Data$1 {}
+/**
+ * Markdown list.
+ */
+interface List extends Parent$1 {
+  /**
+   * Node type of mdast list.
+   */
+  type: "list";
+  /**
+   * Whether the items have been intentionally ordered (when `true`), or that
+   * the order of items is not important (when `false` or not present).
+   */
+  ordered?: boolean | null | undefined;
+  /**
+   * The starting number of the list, when the `ordered` field is `true`.
+   */
+  start?: number | null | undefined;
+  /**
+   * Whether one or more of the children are separated with a blank line from
+   * its siblings (when `true`), or not (when `false` or not present).
+   */
+  spread?: boolean | null | undefined;
+  /**
+   * Children of list.
+   */
+  children: ListContent[];
+  /**
+   * Data associated with the mdast list.
+   */
+  data?: ListData | undefined;
+}
+/**
+ * Info associated with mdast list nodes by the ecosystem.
+ */
+interface ListData extends Data$1 {}
+/**
+ * Markdown list item.
+ */
+interface ListItem extends Parent$1 {
+  /**
+   * Node type of mdast list item.
+   */
+  type: "listItem";
+  /**
+   * Whether the item is a tasklist item (when `boolean`).
+   *
+   * When `true`, the item is complete.
+   * When `false`, the item is incomplete.
+   */
+  checked?: boolean | null | undefined;
+  /**
+   * Whether one or more of the children are separated with a blank line from
+   * its siblings (when `true`), or not (when `false` or not present).
+   */
+  spread?: boolean | null | undefined;
+  /**
+   * Children of list item.
+   */
+  children: Array<BlockContent | DefinitionContent>;
+  /**
+   * Data associated with the mdast list item.
+   */
+  data?: ListItemData | undefined;
+}
+/**
+ * Info associated with mdast list item nodes by the ecosystem.
+ */
+interface ListItemData extends Data$1 {}
+/**
+ * Markdown paragraph.
+ */
+interface Paragraph extends Parent$1 {
+  /**
+   * Node type of mdast paragraph.
+   */
+  type: "paragraph";
+  /**
+   * Children of paragraph.
+   */
+  children: PhrasingContent[];
+  /**
+   * Data associated with the mdast paragraph.
+   */
+  data?: ParagraphData | undefined;
+}
+/**
+ * Info associated with mdast paragraph nodes by the ecosystem.
+ */
+interface ParagraphData extends Data$1 {}
+/**
+ * Document fragment or a whole document.
+ *
+ * Should be used as the root of a tree and must not be used as a child.
+ */
+interface Root$1 extends Parent$1 {
+  /**
+   * Node type of mdast root.
+   */
+  type: "root";
+  /**
+   * Data associated with the mdast root.
+   */
+  data?: RootData$1 | undefined;
+}
+/**
+ * Info associated with mdast root nodes by the ecosystem.
+ */
+interface RootData$1 extends Data$1 {}
+/**
+ * Markdown strong.
+ */
+interface Strong extends Parent$1 {
+  /**
+   * Node type of mdast strong.
+   */
+  type: "strong";
+  /**
+   * Children of strong.
+   */
+  children: PhrasingContent[];
+  /**
+   * Data associated with the mdast strong.
+   */
+  data?: StrongData | undefined;
+}
+/**
+ * Info associated with mdast strong nodes by the ecosystem.
+ */
+interface StrongData extends Data$1 {}
+/**
+ * Markdown GFM table.
+ */
+interface Table extends Parent$1 {
+  /**
+   * Node type of mdast GFM table.
+   */
+  type: "table";
+  /**
+   * How cells in columns are aligned.
+   */
+  align?: AlignType[] | null | undefined;
+  /**
+   * Children of GFM table.
+   */
+  children: TableContent[];
+  /**
+   * Data associated with the mdast GFM table.
+   */
+  data?: TableData | undefined;
+}
+/**
+ * Info associated with mdast GFM table nodes by the ecosystem.
+ */
+interface TableData extends Data$1 {}
+/**
+ * Markdown GFM table row.
+ */
+interface TableRow extends Parent$1 {
+  /**
+   * Node type of mdast GFM table row.
+   */
+  type: "tableRow";
+  /**
+   * Children of GFM table row.
+   */
+  children: RowContent[];
+  /**
+   * Data associated with the mdast GFM table row.
+   */
+  data?: TableRowData | undefined;
+}
+/**
+ * Info associated with mdast GFM table row nodes by the ecosystem.
+ */
+interface TableRowData extends Data$1 {}
+/**
+ * Markdown GFM table cell.
+ */
+interface TableCell extends Parent$1 {
+  /**
+   * Node type of mdast GFM table cell.
+   */
+  type: "tableCell";
+  /**
+   * Children of GFM table cell.
+   */
+  children: PhrasingContent[];
+  /**
+   * Data associated with the mdast GFM table cell.
+   */
+  data?: TableCellData | undefined;
+}
+/**
+ * Info associated with mdast GFM table cell nodes by the ecosystem.
+ */
+interface TableCellData extends Data$1 {}
+/**
+ * Markdown text.
+ */
+interface Text$1 extends Literal$1 {
+  /**
+   * Node type of mdast text.
+   */
+  type: "text";
+  /**
+   * Data associated with the mdast text.
+   */
+  data?: TextData$1 | undefined;
+}
+/**
+ * Info associated with mdast text nodes by the ecosystem.
+ */
+interface TextData$1 extends Data$1 {}
+/**
+ * Markdown thematic break (horizontal rule).
+ */
+interface ThematicBreak extends Node$1 {
+  /**
+   * Node type of mdast thematic break.
+   */
+  type: "thematicBreak";
+  /**
+   * Data associated with the mdast thematic break.
+   */
+  data?: ThematicBreakData | undefined;
+}
+/**
+ * Info associated with mdast thematic break nodes by the ecosystem.
+ */
+interface ThematicBreakData extends Data$1 {}
+/**
+ * Markdown YAML.
+ */
+interface Yaml extends Literal$1 {
+  /**
+   * Node type of mdast YAML.
+   */
+  type: "yaml";
+  /**
+   * Data associated with the mdast YAML.
+   */
+  data?: YamlData | undefined;
+}
 /**
- * Framework-agnostic markdown -> HTML rendering pipeline.
- * Uses the same remark/rehype chain as the Vantage viewer.
+ * Info associated with mdast YAML nodes by the ecosystem.
  */
+interface YamlData extends Data$1 {}
+//#endregion
+//#region src/renderMarkdown.d.ts
 interface RenderOptions {
   /** Enable GFM tables, strikethrough, task lists (default: true) */
   gfm?: boolean;
@@ -18,6 +1046,25 @@ interface RenderOptions {
   sanitize?: boolean;
   /** Parse and strip frontmatter (default: true) */
   frontmatter?: boolean;
+  /**
+   * The body's mdast, already parsed — an optimization, not a second input.
+   *
+   * Parsing is the most expensive step in this function: measured over
+   * `docs/design/`, `remark-parse` with GFM costs about twice what the whole
+   * rehype half costs. A caller that already holds the tree — the CLI checker
+   * does, because every `mdast` rule ran on it before the render rule got its
+   * turn — was paying for the same parse twice.
+   *
+   * The tree must have been parsed by **this package's remark half with these
+   * same options** (`buildRemarkPlugins`, which is exported for exactly that
+   * reason). Anything parsed some other way renders through a chain the viewer
+   * does not use, which is the one thing the shared pipeline exists to prevent,
+   * and nothing here can detect it: a tree is a tree.
+   *
+   * `content` is still read, for its frontmatter. The two have to describe the
+   * same document.
+   */
+  tree?: Root$1;
 }
 interface RenderResult {
   /** The rendered HTML string */
@@ -45,88 +1092,6 @@ interface RenderResult {
  */
 export declare function renderMarkdown(content: string, options?: RenderOptions): Promise<RenderResult>;
 //#endregion
-//#region ../../node_modules/@types/unist/index.d.ts
-// ## Interfaces
-/**
- * Info associated with nodes by the ecosystem.
- *
- * This space is guaranteed to never be specified by unist or specifications
- * implementing unist.
- * But you can use it in utilities and plugins to store data.
- *
- * This type can be augmented to register custom data.
- * For example:
- *
- * ```ts
- * declare module 'unist' {
- *   interface Data {
- *     // `someNode.data.myId` is typed as `number | undefined`
- *     myId?: number | undefined
- *   }
- * }
- * ```
- */
-interface Data$1 {}
-/**
- * One place in a source file.
- */
-interface Point {
-  /**
-   * Line in a source file (1-indexed integer).
-   */
-  line: number;
-  /**
-   * Column in a source file (1-indexed integer).
-   */
-  column: number;
-  /**
-   * Character in a source file (0-indexed integer).
-   */
-  offset?: number | undefined;
-}
-/**
- * Position of a node in a source document.
- *
- * A position is a range between two points.
- */
-interface Position {
-  /**
-   * Place of the first character of the parsed source region.
-   */
-  start: Point;
-  /**
-   * Place of the first character after the parsed source region.
-   */
-  end: Point;
-}
-/**
- * Abstract unist node.
- *
- * The syntactic unit in unist syntax trees are called nodes.
- *
- * This interface is supposed to be extended.
- * If you can use {@link Literal} or {@link Parent}, you should.
- * But for example in markdown, a `thematicBreak` (`***`), is neither literal
- * nor parent, but still a node.
- */
-interface Node$1 {
-  /**
-   * Node type.
-   */
-  type: string;
-  /**
-   * Info from the ecosystem.
-   */
-  data?: Data$1 | undefined;
-  /**
-   * Position of a node in a source document.
-   *
-   * Nodes that are generated (not in the original source document) must not
-   * have a position.
-   */
-  position?: Position | undefined;
-}
-//#endregion
 //#region ../../node_modules/@types/hast/index.d.ts
 // ## Interfaces
 /**
@@ -147,7 +1112,7 @@ interface Node$1 {
  * }
  * ```
  */
-interface Data extends Data$1 {}
+interface Data extends Data$2 {}
 /**
  * Info associated with an element.
  */
@@ -849,7 +1814,7 @@ interface RootContentMap {
  *
  * For a union of all registered hast nodes, see {@link Nodes}.
  */
-interface Node extends Node$1 {
+interface Node extends Node$2 {
   /**
    * Info from the ecosystem.
    */
@@ -902,7 +1867,7 @@ interface CommentData extends Data {}
 /**
  * HTML document type.
  */
-interface Doctype extends Node$1 {
+interface Doctype extends Node$2 {
   /**
    * Node type of HTML document types in hast.
    */
@@ -1133,6 +2098,51 @@ export declare const VANTAGE_RUNS: readonly ["start", "middle", "end", "only"];
  * and said nothing, which is the D5 break this module exists to prevent.
  */
 export declare const VANTAGE_OQ_HOST_TARGETS: ("p" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "li" | "blockquote")[];
+/**
+ * The status emoji the documentation convention marks an Open Question with, and
+ * what each one means to a reader deciding whether the question wants them.
+ *
+ * These are *prose* — ordinary characters in the question's title, not part of
+ * any directive — which is exactly why they need a home that both readers of
+ * them can import. Two consumers ask what a marker means and they must not
+ * answer differently: the checker's `vantage/oq-missing`, which demands a
+ * directive on an open question and must never demand one on a blocked one, and
+ * the viewer's contents column, which shows the marker and needs a word for it
+ * that a screen reader can say. They were private constants in the checker until
+ * the second consumer arrived.
+ *
+ * `open` is the only state that wants a one-click answer. `settled` and
+ * `blocked` deliberately carry no directive at all — a control offering to
+ * answer a question that is already decided, or that cannot be answered yet, is
+ * a lie — so the checker keys on the distinction rather than on the word
+ * "Leaning:" alone. Either non-open marker wins when both appear on one item.
+ */
+export declare const VANTAGE_OQ_STATUS: {
+  /** 💬 — an active decision awaiting a ruling. */
+  readonly open: "💬";
+  /** ✅ — decided, awaiting compaction into a Decision Ledger. */
+  readonly settled: "✅";
+  /** 🔒 — blocked on an upstream decision or experiment. */
+  readonly blocked: "🔒";
+};
+/** One of the convention's three states, as [VANTAGE_OQ_STATUS] names them. */
+type VantageOqStatus = keyof typeof VANTAGE_OQ_STATUS;
+/**
+ * What a marker says, in words, for somewhere an emoji cannot go.
+ *
+ * An accessible name is the reason this exists: a contents entry whose whole
+ * status is one glyph says nothing to a screen reader, and "speech bubble" —
+ * which is what it would otherwise read out — is worse than nothing.
+ */
+export declare const VANTAGE_OQ_STATUS_LABEL: Readonly<Record<VantageOqStatus, string>>;
+/**
+ * The state `text` is marked with, or `null` when it carries no marker.
+ *
+ * Non-open wins over open, the resolution `vantage/oq-missing` has always made:
+ * a question marked both 💬 and ✅ has been answered and the stale marker simply
+ * has not been cleared yet, so treating it as open would re-open a ruling.
+ */
+export declare function vantageOqStatus(text: string): VantageOqStatus | null;
 /** `null` for a key the grammar accepts but no closed set covers. */
 type KeyVocabulary = readonly string[] | null;
 /** The keys one directive name accepts. `undefined` for an unknown key. */
@@ -1205,7 +2215,7 @@ interface PipelineOptions {
   highlight?: boolean;
   /** `data-source-line` attributes for line anchors (default: true) */
   sourceLines?: boolean;
-  /** XSS sanitisation (default: true) */
+  /** XSS sanitization (default: true) */
   sanitize?: boolean;
   /**
    * Lines the frontmatter consumed, added to every emitted line number so
@@ -1266,7 +2276,7 @@ export declare function scrollToLineAnchor(container: HTMLElement, hash: string)
  *
  * Split out from scrollToLineAnchor.ts so that non-browser consumers — the
  * `vantage-check` CLI, which validates `#L42` links against the file on disk —
- * can share the *same* syntax the viewer honours instead of reimplementing it
+ * can share the *same* syntax the viewer honors instead of reimplementing it
  * and drifting.
  */
 /**
@@ -1290,7 +2300,7 @@ type FrontmatterFormat = "yaml" | "toml" | "none";
  *
  * The parser deliberately never throws: a document whose frontmatter is broken
  * still renders, with the block treated as body text. That is the right
- * behaviour for a viewer and the wrong one for an author, who gets no signal
+ * behavior for a viewer and the wrong one for an author, who gets no signal
  * at all — so the reason is recorded here for anything that wants to report it
  * (`vantage-check` does; see its frontmatter rules).
  *
@@ -1352,7 +2362,7 @@ type DocStatus = (typeof DOC_STATUSES)[number];
 /** Every key this build knows under `vantage:`. Closed. */
 export declare const VANTAGE_FRONTMATTER_KEYS: readonly ["status-chip"];
 /**
- * Which tone each status borrows its colours from.
+ * Which tone each status borrows its colors from.
  *
  * The chip has no palette of its own: it reuses the tone chips
  * (`.vantage-chip--<tone>` in `styles/directives.css`), which is also what makes
@@ -1413,7 +2423,7 @@ export declare const SAFE_STYLE: RegExp;
  * `false` — comments are not elements, so `tagNames` has nothing to do with it.
  * `rehypeVantageDirectives` relies on that deletion: it consumes a
  * `<!-- vantage: … -->` comment into attributes and deliberately leaves the node
- * for the sanitiser. Turning the switch on readmits every directive comment —
+ * for the sanitizer. Turning the switch on readmits every directive comment —
  * valid and malformed alike — into the rendered HTML, which breaks the carrier's
  * whole premise. `vantageDirectives.test.ts` ("leaves no comment in the rendered
  * markup") is the guard.
@@ -1455,6 +2465,29 @@ interface RenderMermaidOptions {
  */
 export declare function renderMermaidBlocks(container: HTMLElement, options?: RenderMermaidOptions): Promise<void>;
 //#endregion
+//#region src/mermaidTheme.d.ts
+/**
+ * The attribute on `<html>` naming the active color theme. Absent means the
+ * built-in look. The app sets it only once the theme's stylesheet has loaded,
+ * so a reader of this attribute can trust the theme's variables are in effect.
+ */
+export declare const COLOR_THEME_ATTRIBUTE = "data-vantage-theme";
+/**
+ * The attribute on `<html>` saying where the active theme came from: `"user"`
+ * for a stylesheet in the reader's themes directory, `"built-in"` for one the
+ * app ships. Set with {@link COLOR_THEME_ATTRIBUTE}, and absent with it.
+ *
+ * It exists because an id alone is not a palette. A user theme may share a
+ * built-in's id — that is how a reader tweaks one — and the app applies the
+ * stored built-in synchronously, then swaps in the same-id user file once
+ * /api/themes answers. Keyed on the id, the diagrams drawn in between kept the
+ * built-in's colors: the key did not change, so neither the cache nor
+ * `useSyncExternalStore` saw a reason to redraw.
+ */
+export declare const COLOR_THEME_SOURCE_ATTRIBUTE = "data-vantage-theme-source";
+/** The active color theme's id, or `""` for the built-in look. */
+export declare function currentColorTheme(): string;
+//#endregion
 //#region src/resolveLinks.d.ts
 /**
  * Rewrite relative links in rendered markdown HTML.
@@ -1516,7 +2549,7 @@ export declare function resolveLinks(html: string, options?: ResolveLinkOptions)
  * Every rule stated here should be one a checker can enforce or a renderer
  * actually cares about — if a line is neither, it does not belong.
  */
-export declare const STYLE_GUIDE = "## Markdown style guide (for Vantage viewer)\n\nWhen writing or updating markdown documents that will be viewed in Vantage, follow these conventions:\n\n### Structure\n- Use headings (## and ###) to organize content — they become navigable outline anchors.\n- Keep paragraphs focused and concise. Break up dense text with subheadings, lists, or tables.\n\n### Links and cross-references\n- **Relative paths only**: Always link relative to the *current file's directory*:\n  - Sibling in same folder: `[Other Doc](./other-doc.md)` or `[Other Doc](other-doc.md)`\n  - Subdirectory: `[Design Doc](./design/auth.md)`\n  - Parent / sibling folder: `[Overview](../overview.md)` or `[Spec](../specs/api.md)`\n- **Never use leading slashes**:\n  - ❌ `[Doc](/docs/guide.md)` (breaks web routing and multi-repo scoping)\n  - ✅ `[Doc](../docs/guide.md)` or `[Doc](./guide.md)`\n- **Never use absolute filesystem paths or URI schemes**:\n  - ❌ `file:///workspace/docs/guide.md`, `/workspace/docs/guide.md`, `C:\\...`\n  - ✅ `[Doc](./guide.md)` or `[Doc](../guide.md)`\n- **Always include the file extension**: Use `.md`, `.ts`, `.go`, etc. (e.g. `[Model](model.go)`).\n- **Line anchors and ranges**:\n  - Link to specific lines: `[Handler](../server/api.go#L42)` or `[Range](../server/api.go#L42-L58)`\n  - Same-file line anchor: `[See lines](#L10-L25)`\n  - Vantage scrolls to and highlights the target lines.\n- **Section anchors**:\n  - Same doc: `[Usage](#usage)`\n  - Cross-doc: `[Architecture](../overview.md#system-architecture)`\n  - Anchor slugs are lowercase, hyphenated, and punctuation-stripped.\n- **Backticks in links**: Place backticks inside the link label, not around the markdown link syntax:\n  - ✅ `[`config.json`](./config.json)` or `[config.json](./config.json)`\n  - ❌ ``[config.json](./config.json)``\n\n### Frontmatter (Metadata)\n- Include structured metadata at the very top of docs delimited by `---` (YAML) or `+++` (TOML). Vantage renders this as a metadata card:\n```yaml\n---\ntitle: \"Feature Specification\"\nauthor: \"Agent\"\ndate: 2026-08-15\nstatus: in-review # draft | in-review | accepted | deprecated\ntags: [architecture, backend, api]\nsummary: \"Brief description of the document purpose.\"\nvantage:\n  status-chip: true # show `status` as a chip above the metadata card\n---\n```\n- **Nothing may sit above the opening delimiter** — not a blank line, not an editorial comment, not a `<!-- vantage: … -->` directive. Frontmatter is recognised only at the very first byte of the file (in Vantage, on GitHub, and in every other reader), so one line above it turns the whole block into body text: a horizontal rule followed by a heading made of the raw keys, with every field lost. `vantage-check` reports it as `frontmatter/not-at-top`.\n- **`vantage:` is Vantage's own reserved key.** It holds chrome that belongs to the file rather than to a section, it never shows up in the metadata card, and every other renderer ignores it. One key today: `status-chip`.\n- **Prefer `status-chip: true`**, which shows the document's own `status:` and therefore cannot disagree with it. A literal `status-chip: accepted` is accepted too, but it is a second value that goes stale on its own — `vantage-check` reports the disagreement.\n- The chip's vocabulary is `status`'s, exactly: `draft | in-review | accepted | deprecated`, lowercase. `Draft` renders no chip at all, silently.\n\n### Mermaid diagrams\n- Use ```mermaid code blocks for flowcharts, sequence diagrams, and architecture diagrams. Vantage provides interactive zoom, pan, dark/light theme adaptation, and SVG export.\n- **Quote labels with special characters**: Always quote node labels containing parentheses, brackets, or colons to prevent syntax errors:\n```mermaid\nflowchart TD\n    client[\"Client (React SPA)\"] -->|WebSocket| srv[\"Vantage Server (Go)\"]\n    srv --> git[\"Git CLI (git diff)\"]\n```\n\n### Code blocks and diffs\n- Always tag fenced code blocks with language identifiers (`ts`, `go`, `python`, `bash`, `json`, `yaml`, `diff`, `sql`, etc.) for syntax highlighting.\n- For proposed code modifications, use ```diff blocks with `+` and `-` prefixes:\n```diff\n-const oldUrl = \"/api/v1\";\n+const newUrl = \"/api/v2\";\n```\n\n### Callouts and alerts\n- Use GitHub-style blockquote callouts for notes, tips, and warnings:\n> [!NOTE]\n> Background context or helpful explanation.\n\n> [!TIP]\n> Best practice advice or optimization suggestions.\n\n> [!IMPORTANT]\n> Key requirements or crucial information.\n\n> [!WARNING]\n> Urgent caution, breaking changes, or potential pitfalls.\n\n> [!CAUTION]\n> High-risk actions that could cause data loss or security issues.\n\n### Vantage directives (optional, and Vantage-only)\n\nVantage reads a few styling hints from ordinary HTML comments. Every other renderer — GitHub included — drops them, so a document has to read exactly the same without them: directives decorate, they never carry meaning. One goes on a line of its own, with a blank line after it, and applies to the block that follows:\n\n```markdown\n<!-- vantage: section tone=warning badge=stale -->\n\n## Migration path\n\nThe steps below predate the rewrite.\n```\n\n- **Three names**: `section` (the heading and everything under it), `block` (the one block after it), `oq` (one answerable Open Question).\n- **The keys and values are a closed set**: `tone` = `note | tip | important | warning | caution | muted`; `emphasis` = `strong | normal | quiet`; `badge` = `draft | stale | blocked | done | wip`; `collapsed` = `true | false`. Name a *tone*, never a colour — the theme decides what a warning looks like, in light mode, in dark mode, and in print.\n- **Use them sparingly.** One or two per document, on the sections that genuinely differ. A document where everything is toned says nothing, and a rainbow one is harder to read than a plain one.\n- **Anything outside those sets is silently ignored** — nothing breaks, and nothing styles either. Run `vantage-check` on the document: the `vantage/*` rules are the only thing that will ever tell you a directive did nothing.\n- **Always close the comment with `-->`.** Never `--!>`, and never leave it open: Markdown reads every line below an unclosed `<!--` as part of the comment, and the whole rest of the document vanishes from the page. For the same reason `-->` cannot appear *inside* a value — it ends the comment early and spills the remainder into the page as literal text.\n- **In a list, indent the directive inside the item**, with blank lines around it (below). At the start of a line between two items it ends the list and starts a second one, which changes the numbering and the spacing in every renderer — the one thing a directive must never do.\n- **An open question's id is `OQ-` then an optional short uppercase prefix then digits** — `OQ-9`, `OQ-TP6`, `OQ-A03`. The prefix is what keeps ids distinct once one document references another's questions, so use one in both whenever they cross-reference. `vantage-check` reports anything outside that shape as `vantage/oq-id-format`, and the same id twice in one document as `vantage/oq-id-duplicate` — both are silent otherwise, because the id becomes the block's anchor and a refused or duplicated one simply goes nowhere.\n- **A reference is a link, or it is a lie.** An `OQ-` id, a `§N` section number and a filename all read like pointers, and written as bare prose none of them can be followed or checked — which is exactly why a stale one is never caught. Link the question to its anchor (`[OQ-4](#OQ-4)`, or the Decision Ledger once it is compacted), the section to its heading, the filename to the file. `vantage-check` reports all three (`ref/*`) as errors, and checks that the link points at the thing the reference names rather than merely at something. Writing a specimen rather than a reference? Put it in a fenced block, which the rules never read.\n- **Every open question (💬) with a stated leaning gets an `oq` directive.** The convention's prose — the emoji, the `OQ-N` id, the `_Leaning:_` line, the fill-in `**Answer:**` — produces no button on its own. Writing the convention and stopping there is the most common way this feature goes missing: the questions look complete, review mode is on, and there is nothing to click. **`vantage-check` reports it as an error** (`vantage/oq-missing`), because a question awaiting a ruling that the reviewer cannot file is not a style preference. Mark it 🔒 if it is blocked on something upstream and cannot be answered yet, or ✅ once it is decided; either state needs no directive.\n- **A `leaning` restates the leaning; it is never \"yes\".** The one-click button in review mode files that text as a review comment, and the comment is all the agent reading it has — nobody remembers which button was clicked. `leaning=\"Yes\"` beside a two-branch question is a support ticket.\n\n```markdown\n1. **OQ-9: Queue position on re-entry.**\n\n   <!-- vantage: oq id=OQ-9 leaning=\"Back of the queue — the fix might interact with what merged while it was out.\" -->\n\n   _Leaning:_ Back of the queue.\n```\n\n### Tables, task lists, and math\n- **Tables**: Use standard markdown tables for structured comparisons and schemas.\n- **Task lists**: Use `- [ ]` and `- [x]` for actionable checklists and status tracking.\n- **LaTeX Math**: Use `$$...$$` for *all* KaTeX math — display blocks (`$$` alone on its own lines) and inline alike (`$$E = mc^2$$` mid-sentence).\n  - Single dollars are **not** math delimiters: `$HOME` and `$100` stay literal, so prose and shell snippets are safe to write as-is.\n";
+export declare const STYLE_GUIDE = "## Markdown style guide (for Vantage viewer)\n\nWhen writing or updating markdown documents that will be viewed in Vantage, follow these conventions:\n\n### Structure\n- Use headings (## and ###) to organize content — they become navigable outline anchors.\n- Keep paragraphs focused and concise. Break up dense text with subheadings, lists, or tables.\n\n### Links and cross-references\n- **Relative paths only**: Always link relative to the *current file's directory*:\n  - Sibling in same folder: `[Other Doc](./other-doc.md)` or `[Other Doc](other-doc.md)`\n  - Subdirectory: `[Design Doc](./design/auth.md)`\n  - Parent / sibling folder: `[Overview](../overview.md)` or `[Spec](../specs/api.md)`\n- **Never use leading slashes**:\n  - ❌ `[Doc](/docs/guide.md)` (breaks web routing and multi-repo scoping)\n  - ✅ `[Doc](../docs/guide.md)` or `[Doc](./guide.md)`\n- **Never use absolute filesystem paths or URI schemes**:\n  - ❌ `file:///workspace/docs/guide.md`, `/workspace/docs/guide.md`, `C:\\...`\n  - ✅ `[Doc](./guide.md)` or `[Doc](../guide.md)`\n- **Always include the file extension**: Use `.md`, `.ts`, `.go`, etc. (e.g. `[Model](model.go)`).\n- **Line anchors and ranges**:\n  - Link to specific lines: `[Handler](../server/api.go#L42)` or `[Range](../server/api.go#L42-L58)`\n  - Same-file line anchor: `[See lines](#L10-L25)`\n  - Vantage scrolls to and highlights the target lines.\n- **Section anchors**:\n  - Same doc: `[Usage](#usage)`\n  - Cross-doc: `[Architecture](../overview.md#system-architecture)`\n  - Anchor slugs are lowercase, hyphenated, and punctuation-stripped.\n- **Backticks in links**: Place backticks inside the link label, not around the markdown link syntax:\n  - ✅ `[`config.json`](./config.json)` or `[config.json](./config.json)`\n  - ❌ ``[config.json](./config.json)``\n\n### Frontmatter (Metadata)\n- Include structured metadata at the very top of docs delimited by `---` (YAML) or `+++` (TOML). Vantage renders this as a metadata card:\n```yaml\n---\ntitle: \"Feature Specification\"\nauthor: \"Agent\"\ndate: 2026-08-15\nstatus: in-review # draft | in-review | accepted | deprecated\ntags: [architecture, backend, api]\nsummary: \"Brief description of the document purpose.\"\nvantage:\n  status-chip: true # show `status` as a chip above the metadata card\n---\n```\n- **Nothing may sit above the opening delimiter** — not a blank line, not an editorial comment, not a `<!-- vantage: … -->` directive. Frontmatter is recognized only at the very first byte of the file (in Vantage, on GitHub, and in every other reader), so one line above it turns the whole block into body text: a horizontal rule followed by a heading made of the raw keys, with every field lost. `vantage-check` reports it as `frontmatter/not-at-top`.\n- **`vantage:` is Vantage's own reserved key.** It holds chrome that belongs to the file rather than to a section, it never shows up in the metadata card, and every other renderer ignores it. One key today: `status-chip`.\n- **Prefer `status-chip: true`**, which shows the document's own `status:` and therefore cannot disagree with it. A literal `status-chip: accepted` is accepted too, but it is a second value that goes stale on its own — `vantage-check` reports the disagreement.\n- The chip's vocabulary is `status`'s, exactly: `draft | in-review | accepted | deprecated`, lowercase. `Draft` renders no chip at all, silently.\n\n### Mermaid diagrams\n- Use ```mermaid code blocks for flowcharts, sequence diagrams, and architecture diagrams. Vantage provides interactive zoom, pan, dark/light theme adaptation, and SVG export.\n- **Quote labels with special characters**: Always quote node labels containing parentheses, brackets, or colons to prevent syntax errors:\n```mermaid\nflowchart TD\n    client[\"Client (React SPA)\"] -->|WebSocket| srv[\"Vantage Server (Go)\"]\n    srv --> git[\"Git CLI (git diff)\"]\n```\n\n### Code blocks and diffs\n- Always tag fenced code blocks with language identifiers (`ts`, `go`, `python`, `bash`, `json`, `yaml`, `diff`, `sql`, etc.) for syntax highlighting.\n- For proposed code modifications, use ```diff blocks with `+` and `-` prefixes:\n```diff\n-const oldUrl = \"/api/v1\";\n+const newUrl = \"/api/v2\";\n```\n\n### Callouts and alerts\n- Use GitHub-style blockquote callouts for notes, tips, and warnings:\n> [!NOTE]\n> Background context or helpful explanation.\n\n> [!TIP]\n> Best practice advice or optimization suggestions.\n\n> [!IMPORTANT]\n> Key requirements or crucial information.\n\n> [!WARNING]\n> Urgent caution, breaking changes, or potential pitfalls.\n\n> [!CAUTION]\n> High-risk actions that could cause data loss or security issues.\n\n### Vantage directives (optional, and Vantage-only)\n\nVantage reads a few styling hints from ordinary HTML comments. Every other renderer — GitHub included — drops them, so a document has to read exactly the same without them: directives decorate, they never carry meaning. One goes on a line of its own, with a blank line after it, and applies to the block that follows:\n\n```markdown\n<!-- vantage: section tone=warning badge=stale -->\n\n## Migration path\n\nThe steps below predate the rewrite.\n```\n\n- **Three names**: `section` (the heading and everything under it), `block` (the one block after it), `oq` (one answerable Open Question).\n- **The keys and values are a closed set**: `tone` = `note | tip | important | warning | caution | muted`; `emphasis` = `strong | normal | quiet`; `badge` = `draft | stale | blocked | done | wip`; `collapsed` = `true | false`. Name a *tone*, never a color — the theme decides what a warning looks like, in light mode, in dark mode, and in print.\n- **Use them sparingly.** One or two per document, on the sections that genuinely differ. A document where everything is toned says nothing, and a rainbow one is harder to read than a plain one.\n- **Anything outside those sets is silently ignored** — nothing breaks, and nothing styles either. Run `vantage-check` on the document: the `vantage/*` rules are the only thing that will ever tell you a directive did nothing.\n- **Always close the comment with `-->`.** Never `--!>`, and never leave it open: Markdown reads every line below an unclosed `<!--` as part of the comment, and the whole rest of the document vanishes from the page. For the same reason `-->` cannot appear *inside* a value — it ends the comment early and spills the remainder into the page as literal text.\n- **In a list, indent the directive inside the item**, with blank lines around it (below). At the start of a line between two items it ends the list and starts a second one, which changes the numbering and the spacing in every renderer — the one thing a directive must never do.\n- **An open question's id is `OQ-` then an optional short uppercase prefix then digits** — `OQ-9`, `OQ-TP6`, `OQ-A03`. The prefix is what keeps ids distinct once one document references another's questions, so use one in both whenever they cross-reference. `vantage-check` reports anything outside that shape as `vantage/oq-id-format`, and the same id twice in one document as `vantage/oq-id-duplicate` — both are silent otherwise, because the id becomes the block's anchor and a refused or duplicated one simply goes nowhere.\n- **A reference is a link, or it is a lie.** An `OQ-` id, a `§N` section number and a filename all read like pointers, and written as bare prose none of them can be followed or checked — which is exactly why a stale one is never caught. Link the question to its anchor (`[OQ-4](#OQ-4)`, or the Decision Ledger once it is compacted), the section to its heading, the filename to the file. `vantage-check` reports all three (`ref/*`) as errors, and checks that the link points at the thing the reference names rather than merely at something. Writing a specimen rather than a reference? Put it in a fenced block, which the rules never read.\n- **Every open question (💬) with a stated leaning gets an `oq` directive.** The convention's prose — the emoji, the `OQ-N` id, the `_Leaning:_` line, the fill-in `**Answer:**` — produces no button on its own. Writing the convention and stopping there is the most common way this feature goes missing: the questions look complete, review mode is on, and there is nothing to click. **`vantage-check` reports it as an error** (`vantage/oq-missing`), because a question awaiting a ruling that the reviewer cannot file is not a style preference. Mark it 🔒 if it is blocked on something upstream and cannot be answered yet, or ✅ once it is decided; either state needs no directive.\n- **A `leaning` restates the leaning; it is never \"yes\".** The one-click button in review mode files that text as a review comment, and the comment is all the agent reading it has — nobody remembers which button was clicked. `leaning=\"Yes\"` beside a two-branch question is a support ticket.\n\n```markdown\n1. **OQ-9: Queue position on re-entry.**\n\n   <!-- vantage: oq id=OQ-9 leaning=\"Back of the queue — the fix might interact with what merged while it was out.\" -->\n\n   _Leaning:_ Back of the queue.\n```\n\n### Tables, task lists, and math\n- **Tables**: Use standard markdown tables for structured comparisons and schemas.\n- **Task lists**: Use `- [ ]` and `- [x]` for actionable checklists and status tracking.\n- **LaTeX Math**: Use `$$...$$` for *all* KaTeX math — display blocks (`$$` alone on its own lines) and inline alike (`$$E = mc^2$$` mid-sentence).\n  - Single dollars are **not** math delimiters: `$HOME` and `$100` stay literal, so prose and shell snippets are safe to write as-is.\n";
 //#endregion
-export { type DirectivePair, type DirectiveParse, type DirectiveVocabulary, type DocStatus, type FrontmatterFormat, type FrontmatterProblem, type KeyTable, type KeyVocabulary, type MalformedDirective, type ParsedDirective, type ParsedFrontmatter, type Pipeline, type PipelineOptions, type RenderMermaidOptions, type RenderOptions, type RenderResult, type ResolveLinkOptions, type VantageAlert, type VantageFrontmatter, type VantageFrontmatterIssue, rehypeSourceLines, rehypeVantageAnchors, rehypeVantageDirectives };
+export { type DirectivePair, type DirectiveParse, type DirectiveVocabulary, type DocStatus, type FrontmatterFormat, type FrontmatterProblem, type KeyTable, type KeyVocabulary, type MalformedDirective, type ParsedDirective, type ParsedFrontmatter, type Pipeline, type PipelineOptions, type RenderMermaidOptions, type RenderOptions, type RenderResult, type ResolveLinkOptions, type VantageAlert, type VantageFrontmatter, type VantageFrontmatterIssue, type VantageOqStatus, rehypeSourceLines, rehypeVantageAnchors, rehypeVantageDirectives };
 //# sourceMappingURL=index.d.ts.map