vantage-md 0.1.3 → 0.5.4

package/README.md

@@ -73,18 +73,33 @@ function Docs({ content, path }) {
 
 The React component includes mermaid diagram rendering (lazy-loaded), frontmatter display, and syntax highlighting out of the box.
 
-### Rehype plugin (bring your own pipeline)
+### Your own processor, Vantage's chain
+
+`buildPipeline` returns the exact remark and rehype lists `renderMarkdown` and
+the React viewer use, in the exact order — including the sanitiser schema, and
+`rehypeSlug` after it, which is what keeps generated heading ids free of
+`rehype-sanitize`'s `user-content-` prefix. Use it rather than assembling the
+chain yourself; that is how a document ends up rendering differently in two
+places.
 
 ```typescript
-import { rehypeSourceLines } from "vantage-md";
+import { buildPipeline } from "vantage-md";
+
+const { remarkPlugins, rehypePlugins } = buildPipeline({ bodyLineOffset: 0 });
 
 const processor = unified()
   .use(remarkParse)
-  .use(remarkRehype)
-  .use(rehypeSourceLines)  // adds data-source-line to block elements
+  .use(remarkPlugins)
+  .use(remarkRehype, { allowDangerousHtml: true })
+  .use(rehypePlugins)
   .use(rehypeStringify);
 ```
 
+Every plugin is toggleable (`gfm`, `math`, `highlight`, `sourceLines`,
+`sanitize`), and `buildRemarkPlugins` returns the mdast half alone for tools
+that parse without rendering. `rehypeSourceLines` is still exported on its own
+if all you want is `data-source-line`.
+
 ### Svelte / Vue / plain HTML
 
 ```svelte
@@ -103,18 +118,18 @@ const processor = unified()
 
 | Entry point | Description |
 |-------------|-------------|
-| `vantage-md` | `renderMarkdown`, `rehypeSourceLines`, `scrollToLineAnchor`, `parseLineAnchor`, `parseFrontmatter`, `sanitizeSchema` |
-| `vantage-md/react` | `MarkdownViewer`, `useLineAnchor`, `MermaidDiagram`, `FrontmatterDisplay` + all core exports |
-| `vantage-md/styles` | Line-anchor highlight CSS (light + dark mode) |
+| `vantage-md` | `renderMarkdown`, `buildPipeline`, `buildRemarkPlugins`, `rehypeSourceLines`, `scrollToLineAnchor`, `parseLineAnchor`, `parseFrontmatter`, `readVantageFrontmatter`, `sanitizeSchema` |
+| `vantage-md/react` | `MarkdownViewer`, `useLineAnchor`, `MermaidDiagram`, `FrontmatterDisplay`, `DocumentStatusChip` + all core exports |
+| `vantage-md/styles` | Line-anchor highlight CSS, plus the theme layer for the `data-vantage-*` directive attributes and the chrome chips (light + dark mode) |
 
 ## Features
 
 - **Line anchors** — `data-source-line` attributes on every block element, with scroll/highlight utilities
 - **GFM** — tables, strikethrough, task lists, autolinks
-- **KaTeX** — `$$...$$` math blocks
+- **KaTeX** — `$$...$$` math, inline and block (single `$` is not a delimiter, so `$HOME` and `$100` stay literal)
 - **Mermaid** — diagram rendering (client-side, lazy-loaded)
 - **Syntax highlighting** — via highlight.js
-- **Frontmatter** — YAML (`---`) and TOML (`+++`) parsing
+- **Frontmatter** — YAML (`---`) and TOML (`+++`) parsing. A reserved `vantage:` key carries file-scoped chrome: `status-chip: true` makes `FrontmatterDisplay` render the document's `status:` as a chip above the metadata card, and the reserved key itself is never shown as a metadata row
 - **Sanitization** — XSS-safe with allowlisted KaTeX/MathML elements
 - **Dark mode** — all styles support `.dark` class