@umami/shiso 1.11.0 → 1.13.0

package/dist/components.js

@@ -1,3 +1,3 @@
-import { At as Danger, Bt as AccordionGroup, Dt as CardGroup, Et as Card, Ft as WarningBanner, It as Button, Lt as Badge, Mt as Note, Nt as Tip, Ot as Callout, Pt as Warning, St as CodeGroup, _ as Tooltip, at as Tabs, bt as Column, ct as ResponseField, dt as ParamField, ft as Link, gt as Expandable, it as Tab, jt as Info, kt as Check, lt as PropertiesTable, mt as Frame, n as ZoomableImage, ot as Step, pt as Icon, st as Steps, ut as Param, xt as Columns, zt as Accordion } from "./chunks/docs.js";
+import { $t as Accordion, Bt as Card, C as Tooltip, Ct as useSetPanelContent, Et as Frame, Gt as Info, Ht as Callout, Jt as Warning, Kt as Note, Mt as Column, Nt as Columns, Ot as Expandable, Pt as CodeGroup, Rt as Changelog, S as TreeFolder, Sn as mermaidSource, St as usePanelContent, Tt as Icon, Ut as Check, Vt as CardGroup, Wt as Danger, Xt as Button, Yt as WarningBanner, Zt as Badge, _ as FileTree, _t as PropertiesTable, b as Tree, bt as Panel, dt as Tiles, en as AccordionGroup, ft as Tab, gt as ResponseField, ht as Steps, mt as Step, n as ZoomableImage, pt as Tabs, qt as Tip, ut as Tile, v as FileTreeFile, vt as Param, wt as Link, x as TreeFile, xn as Mermaid, xt as PanelProvider, y as FileTreeFolder, yt as ParamField, zt as Update } from "./chunks/docs.js";
 
-export { Accordion, AccordionGroup, Badge, Button, Callout, Card, CardGroup, Check, CodeGroup, Column, Columns, Danger, Expandable, Frame, Icon, Info, Link, Note, Param, ParamField, PropertiesTable, ResponseField, Step, Steps, Tab, Tabs, Tip, Tooltip, Warning, WarningBanner, ZoomableImage };
+export { Accordion, AccordionGroup, Badge, Button, Callout, Card, CardGroup, Changelog, Check, CodeGroup, Column, Columns, Danger, Expandable, FileTree, FileTreeFile, FileTreeFolder, Frame, Icon, Info, Link, Mermaid, Note, Panel, PanelProvider, Param, ParamField, PropertiesTable, ResponseField, Step, Steps, Tab, Tabs, Tile, Tiles, Tip, Tooltip, Tree, TreeFile, TreeFolder, Update, Warning, WarningBanner, ZoomableImage, mermaidSource, usePanelContent, useSetPanelContent };

package/dist/entry-client.js

@@ -1,5 +1,5 @@
-import { ar as BrowserRouter } from "./chunks/docs.js";
-import { m as BASE_URL, t as App } from "./chunks/App.js";
+import { Sr as BrowserRouter } from "./chunks/docs.js";
+import { h as BASE_URL, t as App } from "./chunks/App.js";
 import { jsx } from "react/jsx-runtime";
 
 //#region src/entry-client.tsx

package/dist/entry-server.js

@@ -1,5 +1,5 @@
-import { hr as ABSOLUTE_URL_REGEX, lr as Router, mr as parsePath, pr as createPath } from "./chunks/docs.js";
-import { a as docsSite, c as getSeo, d as getDocModule, f as getLastModified, h as toAbsoluteUrl, i as docsHomeUrl, l as siteName, m as BASE_URL, n as buildHead, o as getLocaleByPathname, p as getScopeForPage, r as renderHeadToString, s as getRedirects, t as App, u as standalonePages } from "./chunks/App.js";
+import { Ar as createPath, Er as Router, Mr as ABSOLUTE_URL_REGEX, jr as parsePath } from "./chunks/docs.js";
+import { a as docsSite, c as getSeo, d as standalonePages, f as getDocModule, g as toAbsoluteUrl, h as BASE_URL, i as docsHomeUrl, l as siteConfig, m as getScopeForPage, n as buildHead, o as getLocaleByPathname, p as getLastModified, r as renderHeadToString, s as getRedirects, t as App, u as siteName } from "./chunks/App.js";
 import * as React$1 from "react";
 import { jsx } from "react/jsx-runtime";
 import { renderToString } from "react-dom/server";
@@ -107,6 +107,33 @@ function getMarkdownPages() {
 		filePath: page.filePath
 	}))];
 }
+/** Navigable Markdown pages used to generate llms.txt and llms-full.txt. */
+function getLlmsPages() {
+	const { indexing } = getSeo();
+	const pages = [];
+	for (const page of docsSite.pages) {
+		const doc = getDocModule(page.filePath);
+		if (doc?.frontmatter?.noindex === true || (page.hidden || getScopeForPage(docsSite, page).hidden) && indexing !== "all") continue;
+		pages.push({
+			route: page.url,
+			filePath: page.filePath,
+			title: doc?.frontmatter?.title || page.label,
+			description: doc?.frontmatter?.description
+		});
+	}
+	for (const page of standalonePages) {
+		if (page.filePath.endsWith(".tsx")) continue;
+		const doc = getDocModule(page.filePath);
+		if (doc?.frontmatter?.noindex === true) continue;
+		pages.push({
+			route: page.path,
+			filePath: page.filePath,
+			title: doc?.frontmatter?.title || page.title || page.path,
+			description: doc?.frontmatter?.description
+		});
+	}
+	return pages;
+}
 /**
 * Absolute URLs for the sitemap, honoring `seo.indexing` and per-page
 * noindex. Empty when the shiso.config `siteUrl` is not configured, since a sitemap
@@ -145,6 +172,7 @@ function render(url) {
 		htmlAttrs: getLocaleByPathname(url)
 	};
 }
+const siteDescription = siteConfig.description;
 
 //#endregion
-export { docsHomeUrl, getMarkdownPages, getRedirects, getRoutes, getSitemapEntries, render, siteName };
+export { docsHomeUrl, getLlmsPages, getMarkdownPages, getRedirects, getRoutes, getSitemapEntries, render, siteDescription, siteName };

package/docs.schema.json

@@ -172,6 +172,37 @@
           ],
           "description": "Page eyebrow style: the section name (default) or the full navigation path.",
           "default": "section"
+        },
+        "codeBlocks": {
+          "type": "object",
+          "description": "Fenced code block defaults: line numbers and the Shiki light/dark themes.",
+          "additionalProperties": false,
+          "properties": {
+            "$ref": { "$ref": "#/definitions/configRef" },
+            "lineNumbers": {
+              "allOf": [{ "$ref": "#/definitions/booleanValue" }],
+              "description": "Show line numbers on every block. Override per block with showLineNumbers or hideLineNumbers in the fence meta.",
+              "default": false
+            },
+            "theme": {
+              "type": "object",
+              "description": "Bundled Shiki theme names for each color mode (https://shiki.style/themes).",
+              "additionalProperties": false,
+              "properties": {
+                "$ref": { "$ref": "#/definitions/configRef" },
+                "light": {
+                  "allOf": [{ "$ref": "#/definitions/nonEmptyStringValue" }],
+                  "description": "Theme used in light mode.",
+                  "default": "github-light"
+                },
+                "dark": {
+                  "allOf": [{ "$ref": "#/definitions/nonEmptyStringValue" }],
+                  "description": "Theme used in dark mode.",
+                  "default": "github-dark"
+                }
+              }
+            }
+          }
         }
       }
     },
@@ -567,6 +598,24 @@
         }
       }
     },
+    "api": {
+      "type": "object",
+      "description": "API reference settings: the OpenAPI spec powering openapi frontmatter pages.",
+      "anyOf": [{ "required": ["$ref"] }, { "required": ["spec"] }],
+      "additionalProperties": false,
+      "properties": {
+        "$ref": { "$ref": "#/definitions/configRef" },
+        "spec": {
+          "allOf": [{ "$ref": "#/definitions/nonEmptyStringValue" }],
+          "description": "Path to a local OpenAPI 3.0 or 3.1 spec (JSON or YAML), relative to the project root."
+        },
+        "directory": {
+          "allOf": [{ "$ref": "#/definitions/nonEmptyStringValue" }],
+          "description": "Folder inside the content directory for generated endpoint pages.",
+          "default": "api-reference"
+        }
+      }
+    },
     "errors": {
       "type": "object",
       "description": "Error handling settings.",
@@ -712,6 +761,8 @@
           "description": "Page reference relative to the content directory, without extension (e.g. \"components/tabs\")."
         },
         { "$ref": "#/definitions/pageObject" },
+        { "$ref": "#/definitions/globItem" },
+        { "$ref": "#/definitions/openapiItem" },
         { "$ref": "#/definitions/linkItem" },
         { "$ref": "#/definitions/group" }
       ]
@@ -736,12 +787,51 @@
         },
         "icon": { "allOf": [{ "$ref": "#/definitions/stringValue" }], "description": "Icon name shown beside the label." },
         "tag": { "allOf": [{ "$ref": "#/definitions/stringValue" }], "description": "Short label shown after the page name." },
+        "method": {
+          "anyOf": [
+            { "enum": ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS", "TRACE"] },
+            { "$ref": "#/definitions/configRefValue" }
+          ],
+          "description": "HTTP method badge shown after the page name on API reference pages."
+        },
         "hidden": {
           "allOf": [{ "$ref": "#/definitions/booleanValue" }],
           "description": "Hide from the sidebar and search. The page is still built and reachable by URL."
         }
       }
     },
+    "globItem": {
+      "type": "object",
+      "required": ["glob"],
+      "additionalProperties": false,
+      "properties": {
+        "glob": {
+          "allOf": [{ "$ref": "#/definitions/nonEmptyStringValue" }],
+          "description": "Glob relative to contentDir. Matching Markdown and MDX files are expanded into page entries; explicit page references take precedence."
+        },
+        "exclude": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": { "$ref": "#/definitions/nonEmptyStringValue" }
+            },
+            { "$ref": "#/definitions/configRefValue" }
+          ],
+          "description": "Optional glob patterns to omit from the matches."
+        }
+      }
+    },
+    "openapiItem": {
+      "type": "object",
+      "required": ["openapi"],
+      "additionalProperties": false,
+      "properties": {
+        "openapi": {
+          "anyOf": [{ "type": "boolean" }, { "$ref": "#/definitions/nonEmptyStringValue" }],
+          "description": "Expand API endpoints into pages: true for every tag (grouped), or a tag name for that tag's operations. Requires the api.spec setting."
+        }
+      }
+    },
     "linkItem": {
       "type": "object",
       "description": "An external link in the navigation tree.",

package/mdx.config.ts

@@ -1,104 +1,19 @@
 import mdx from '@mdx-js/rollup';
 import rehypeAutolinkHeadings from 'rehype-autolink-headings';
-import rehypeHighlight from 'rehype-highlight';
 import rehypeSlug from 'rehype-slug';
 import remarkFrontmatter from 'remark-frontmatter';
 import remarkGfm from 'remark-gfm';
 import remarkMdxFrontmatter from 'remark-mdx-frontmatter';
 import type { Plugin } from 'vite';
-import { type MdNode, toText, walkTree } from './src/lib/mdast.ts';
+import { resolveCodeBlockConfig } from './src/lib/code-blocks.ts';
+import { type MdNode, toText } from './src/lib/mdast.ts';
+import { rehypeShiki } from './src/lib/rehype-shiki.ts';
 import { remarkToc } from './src/lib/remark-toc.ts';
+import type { MdxConfig, ResolvedCodeBlockConfig } from './src/lib/types.ts';
 
-const SYNTHETIC_FRAGMENT = 'data-shiso-synthetic-fragment';
-
-function remarkCodeTitles() {
-  return (tree: MdNode) => {
-    const visit = (node: MdNode) => {
-      if (node.type === 'code' && node.meta?.trim()) {
-        const meta = node.meta.trim();
-        const titleMatch = meta.match(/(?:^|\s)title=(?:"([^"]+)"|'([^']+)'|([^\s]+))/);
-        const title = titleMatch ? titleMatch[1] || titleMatch[2] || titleMatch[3] : meta;
-        const hProperties = (node.data?.hProperties || {}) as Record<string, unknown>;
-        node.data = {
-          ...node.data,
-          hProperties: { ...hProperties, 'data-title': title },
-        };
-      }
-
-      node.children?.forEach(visit);
-    };
-
-    visit(tree);
-  };
-}
-
-function rehypeWrapJsxForHighlighting() {
-  return (tree: MdNode) => {
-    walkTree(tree, node => {
-      if (node.tagName !== 'code') {
-        return;
-      }
-
-      const properties = (node.properties || {}) as Record<string, unknown>;
-      const className = properties.className;
-      const classes = Array.isArray(className) ? className.map(String) : [String(className || '')];
-      const source = toText(node);
-
-      if (!classes.some(value => /\blanguage-(?:jsx|tsx)\b/.test(value))) {
-        return;
-      }
-
-      if (!/^\s*<[A-Z][\w.]*(?:\s|>|\/)/.test(source)) {
-        return;
-      }
-
-      properties[SYNTHETIC_FRAGMENT] = true;
-      node.properties = properties;
-      node.children = [{ type: 'text', value: `<>\n${source}\n</>` }];
-    });
-  };
-}
-
-function boundaryText(node: MdNode, fromEnd = false): MdNode | undefined {
-  if (node.type === 'text' && typeof node.value === 'string') {
-    return node;
-  }
-
-  const children = fromEnd ? [...(node.children || [])].reverse() : node.children || [];
-  for (const child of children) {
-    const match = boundaryText(child, fromEnd);
-    if (match) {
-      return match;
-    }
-  }
-
-  return undefined;
-}
-
-function rehypeRemoveHighlightingFragments() {
-  return (tree: MdNode) => {
-    walkTree(tree, node => {
-      if (node.tagName !== 'code') {
-        return;
-      }
-
-      const properties = (node.properties || {}) as Record<string, unknown>;
-      if (!properties[SYNTHETIC_FRAGMENT]) {
-        return;
-      }
-
-      const first = boundaryText(node);
-      const last = boundaryText(node, true);
-      if (first?.value) {
-        first.value = first.value.replace(/^<>\r?\n/, '');
-      }
-      if (last?.value) {
-        last.value = last.value.replace(/\r?\n<\/>$/, '');
-      }
-
-      delete properties[SYNTHETIC_FRAGMENT];
-    });
-  };
+export interface ShisoMdxOptions extends MdxConfig {
+  /** Resolved docs.json `styling.codeBlocks`; defaults apply when omitted. */
+  codeBlocks?: ResolvedCodeBlockConfig;
 }
 
 function rehypeZoomableImages() {
@@ -142,7 +57,9 @@ function rehypeZoomableImages() {
  * The MDX compilation pipeline, shared by the app build and the test runner so
  * tests exercise the same transforms the site ships with.
  */
-export function shisoMdx(): Plugin {
+export function shisoMdx(options: ShisoMdxOptions = {}): Plugin {
+  const codeBlocks = options.codeBlocks || resolveCodeBlockConfig();
+
   return {
     // Must run before vite:react-babel so MDX is compiled to JSX first.
     enforce: 'pre',
@@ -152,13 +69,12 @@ export function shisoMdx(): Plugin {
         remarkFrontmatter,
         remarkMdxFrontmatter,
         remarkGfm,
-        remarkCodeTitles,
+        ...(options.remarkPlugins || []),
         remarkToc,
       ],
       rehypePlugins: [
-        rehypeWrapJsxForHighlighting,
-        rehypeHighlight,
-        rehypeRemoveHighlightingFragments,
+        ...(options.rehypePlugins || []),
+        [rehypeShiki, codeBlocks],
         rehypeZoomableImages,
         rehypeSlug,
         [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umami/shiso",
-  "version": "1.11.0",
+  "version": "1.13.0",
   "description": "Open-source documentation framework for Markdown and MDX sites.",
   "type": "module",
   "bin": {
@@ -72,6 +72,7 @@
     "@fontsource/jetbrains-mono": "^5.2.5",
     "@mdx-js/react": "^3.1.1",
     "@mdx-js/rollup": "^3.1.1",
+    "@shikijs/transformers": "^4.4.3",
     "@tailwindcss/vite": "^4.3.3",
     "@vitejs/plugin-react": "^6.0.5",
     "ajv": "^8.20.0",
@@ -80,24 +81,25 @@
     "cmdk": "^1.1.1",
     "estree-util-value-to-estree": "^3.5.0",
     "github-slugger": "^2.0.0",
-    "highlight.js": "^11.11.1",
     "jiti": "^2.4.0",
     "lucide-react": "^1.28.0",
+    "mermaid": "^11.17.2",
     "react-router": "^8.3.0",
     "rehype-autolink-headings": "^7.1.0",
-    "rehype-highlight": "^7.0.1",
     "rehype-slug": "^6.0.0",
     "remark-frontmatter": "^5.0.0",
     "remark-gfm": "^4.0.0",
     "remark-mdx": "^3.1.1",
     "remark-mdx-frontmatter": "^5.2.0",
     "remark-parse": "^11.0.0",
+    "shiki": "^4.4.3",
     "simple-icons": "^16.28.0",
     "tailwind-merge": "^3.6.0",
     "tailwindcss": "^4.3.3",
     "tw-animate-css": "^1.4.0",
     "unified": "^11.0.5",
-    "vite": "^8.2.0"
+    "vite": "^8.2.0",
+    "yaml": "^2.9.0"
   },
   "optionalDependencies": {
     "pagefind": "^1.4.0"

package/scripts/build-runtime.mjs

@@ -10,6 +10,7 @@ const outputRoot = path.join(packageRoot, 'dist');
 const projectModules = new Set([
   '@/generated/last-modified',
   '@/lib/icon-registry.generated',
+  '@/lib/openapi.generated',
   '@/lib/search-index.generated',
   'virtual:shiso-docs-config',
   'virtual:shiso-config',