@ox-content/vite-plugin 3.0.0-alpha.3 → 3.0.0-alpha.5

package/dist/index.cjs

@@ -140,8 +140,8 @@ function normalizeClassName(className) {
 * Highlights with the native tree-sitter engine, or `null` when it has no
 * grammar for `lang`.
 *
-* It emits `--octc-shiki-*` markup (the `shiki` prefix is historical) so
-* theme-color packages keep working.
+* It emits `--octc-syntax-*` markup so theme-color packages resolve token
+* colors.
 */
 function highlightNatively(code, lang) {
 	try {
@@ -168,8 +168,8 @@ async function highlightDocumentNatively(html) {
 /**
 * Syntax highlighting with the native tree-sitter engine.
 *
-* Markup keeps the historical `<pre class="shiki css-variables">` wrapper and
-* `--octc-shiki-*` custom properties so theme-color packages keep working.
+* Markup uses `<pre class="ox-highlight css-variables">` and `--octc-syntax-*`
+* custom properties so theme-color packages resolve token colors.
 */
 const rehypeParse$3 = require_interop.interopDefault(rehype_parse.default);
 const rehypeStringify$3 = require_interop.interopDefault(rehype_stringify.default);
@@ -213,7 +213,7 @@ function rehypeNativeHighlight() {
 						highlightedCode.properties.className = [.../* @__PURE__ */ new Set([
 							...originalCodeClasses,
 							...highlightedClasses,
-							"shiki-inline"
+							"ox-highlight-inline"
 						])];
 						highlightedCode.properties["data-language"] = lang;
 						return highlightedCode;
@@ -228,7 +228,7 @@ function rehypeNativeHighlight() {
 				const child = node.children[i];
 				if (child.type === "element" && child.tagName === "pre") {
 					const codeElement = child.children.find((c) => c.type === "element" && c.tagName === "code");
-					const alreadyHighlighted = normalizeClassName(child.properties?.className).includes("shiki");
+					const alreadyHighlighted = normalizeClassName(child.properties?.className).includes("ox-highlight");
 					if (codeElement && !alreadyHighlighted) {
 						const highlightedPre = highlightBlockCode(codeElement);
 						if (highlightedPre) node.children[i] = highlightedPre;
@@ -1762,7 +1762,7 @@ async function transformOgp(html, ogpDataMap, options) {
 const SELF_CLOSING_EMBED_TAG = /<(GitHub|OgCard|Tweet|XPost|Bluesky|Spotify|StackBlitz|WebContainer|YouTube)((?:[^>"']|"[^"]*"|'[^']*')*?)\s*\/>/gi;
 /**
 * Custom embed tags are not HTML void elements, so a self-closing authoring
-* form like `<GitHub ... />` reaches the HTML re-parsers (Shiki highlighting,
+* form like `<GitHub ... />` reaches the HTML re-parsers (syntax highlighting,
 * embed transforms) as an unclosed element that swallows the rest of the
 * document. Normalize to an explicit open/close pair before any rehype pass
 * runs.
@@ -2210,7 +2210,8 @@ async function applyTypedHover(source, html, options) {
 	if (fences.length === 0) return html;
 	try {
 		return attachTypedHoverPayloads(html, await generateTypedHoverAttachments(fences, options.tsgoCommand));
-	} catch {
+	} catch (error) {
+		console.warn("[ox-content] typedHover failed; leaving the fence unannotated.", error);
 		return html;
 	}
 }
@@ -2302,10 +2303,16 @@ function normalizeFenceText(value) {
 	return decodeHtmlEntities(value).replace(/\r\n/g, "\n").trim();
 }
 function decodeHtmlEntities(value) {
-	return value.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&").replace(/&quot;/g, "\"").replace(/&#39;/g, "'");
+	return value.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&quot;/g, "\"").replace(/&#39;/g, "'").replace(/&#x([0-9a-fA-F]+);/g, (_, hex) => {
+		const code = Number.parseInt(hex, 16);
+		return Number.isFinite(code) ? String.fromCodePoint(code) : "";
+	}).replace(/&#(\d+);/g, (_, dec) => {
+		const code = Number.parseInt(dec, 10);
+		return Number.isFinite(code) ? String.fromCodePoint(code) : "";
+	}).replace(/&amp;/g, "&");
 }
 const TYPED_HOVER_STYLE = `<style data-ox-typed-hover-style>.ox-typed-hover-token{cursor:help;text-decoration:underline dotted}.ox-typed-hover-overlay{position:fixed;z-index:50;max-width:36rem;padding:.35rem .55rem;border:1px solid #444;border-radius:4px;background:#1e1e1e;color:#d4d4d4;font:12px/1.4 ui-monospace,SFMono-Regular,Menlo,monospace;white-space:pre-wrap;pointer-events:none}</style>`;
-const TYPED_HOVER_CLIENT = `<script data-ox-typed-hover-runtime>(function(){if(window.__oxTypedHover)return;window.__oxTypedHover=1;var tip=document.createElement("div");tip.className="ox-typed-hover-overlay";tip.setAttribute("role","tooltip");tip.hidden=true;document.body.appendChild(tip);function payload(token){var pre=token.closest(".ox-typed-hover");var data=pre&&pre.nextElementSibling;if(!data||!data.classList.contains("ox-typed-hover-data"))return null;try{return JSON.parse(data.textContent||"")}catch(e){return null}}function show(token){var data=payload(token);var item=data&&data.hovers[Number(token.getAttribute("data-ox-typed-hover"))];if(!item)return;tip.textContent=item.type;tip.hidden=false;var box=token.getBoundingClientRect();tip.style.left=Math.max(8,box.left)+"px";tip.style.top=Math.max(8,box.top-tip.offsetHeight-8)+"px"}function hide(){tip.hidden=true}document.addEventListener("mouseover",function(e){var t=e.target.closest(".ox-typed-hover-token");if(t)show(t)});document.addEventListener("mouseout",function(e){var t=e.target.closest(".ox-typed-hover-token");if(t&&!t.contains(e.relatedTarget))hide()});document.addEventListener("focusin",function(e){var t=e.target.closest(".ox-typed-hover-token");if(t)show(t)});document.addEventListener("focusout",function(e){if(!e.relatedTarget||!e.relatedTarget.closest(".ox-typed-hover-token"))hide()});document.addEventListener("keydown",function(e){if(e.key==="Escape")hide()})})();<\/script>`;
+const TYPED_HOVER_CLIENT = `<script data-ox-typed-hover-runtime>(function(){if(window.__oxTypedHover)return;window.__oxTypedHover=1;var tip=document.createElement("div");tip.className="ox-typed-hover-overlay";tip.setAttribute("role","tooltip");tip.hidden=true;document.body.appendChild(tip);function payload(token){var pre=token.closest(".ox-typed-hover");if(!pre)return null;var host=pre.closest(".ox-code")||pre;var data=host.nextElementSibling;if(!data||!data.classList.contains("ox-typed-hover-data"))return null;try{return JSON.parse(data.textContent||"")}catch(e){return null}}function show(token){var data=payload(token);var item=data&&data.hovers[Number(token.getAttribute("data-ox-typed-hover"))];if(!item)return;tip.textContent=item.type;tip.hidden=false;var box=token.getBoundingClientRect();tip.style.left=Math.max(8,box.left)+"px";tip.style.top=Math.max(8,box.top-tip.offsetHeight-8)+"px"}function hide(){tip.hidden=true}document.addEventListener("mouseover",function(e){var t=e.target.closest(".ox-typed-hover-token");if(t)show(t)});document.addEventListener("mouseout",function(e){var t=e.target.closest(".ox-typed-hover-token");if(t&&!t.contains(e.relatedTarget))hide()});document.addEventListener("focusin",function(e){var t=e.target.closest(".ox-typed-hover-token");if(t)show(t)});document.addEventListener("focusout",function(e){if(!e.relatedTarget||!e.relatedTarget.closest(".ox-typed-hover-token"))hide()});document.addEventListener("keydown",function(e){if(e.key==="Escape")hide()})})();<\/script>`;
 //#endregion
 //#region src/file-tree-options.ts
 const disabled = {
@@ -4131,6 +4138,22 @@ function stripLocalePrefix(sitePath, locales) {
 	return normalized;
 }
 //#endregion
+//#region src/page-head.ts
+/** Resolve descriptors to escaped `<head>` markup. Build-time only. */
+function renderHead(input) {
+	return require_vitepress.importNapiModuleSync().renderHead(JSON.stringify(input));
+}
+function resolveHeadValidation(value) {
+	if (value === "warn" || value === "strict") return value;
+	return false;
+}
+function reportHeadDiagnostics(diagnostics, validation) {
+	if (!validation || diagnostics.length === 0) return;
+	const fatal = diagnostics.filter((item) => item.strict);
+	if (validation === "strict" && fatal.length > 0) throw new Error(`[ox-content] ${fatal[0].message}`);
+	if (validation === "warn") for (const item of diagnostics) console.warn(`[ox-content] ${item.message}`);
+}
+//#endregion
 //#region src/page-context.ts
 var page_context_exports = /* @__PURE__ */ require_vitepress.__exportAll({
 	clearRenderContext: () => clearRenderContext,
@@ -9250,6 +9273,7 @@ function resolveSsgOptions(ssg) {
 		pagination: false,
 		breadcrumbs: false,
 		jsonLd: false,
+		headValidation: false,
 		readerChrome: false,
 		localeSwitcher: false,
 		a11y: false,
@@ -9270,6 +9294,7 @@ function resolveSsgOptions(ssg) {
 		pagination: false,
 		breadcrumbs: false,
 		jsonLd: false,
+		headValidation: false,
 		readerChrome: false,
 		localeSwitcher: false,
 		a11y: false,
@@ -9298,6 +9323,7 @@ function resolveSsgOptions(ssg) {
 		pagination: resolvePaginationOption(ssg.pagination),
 		breadcrumbs: resolvePaginationOption(ssg.breadcrumbs),
 		jsonLd: resolveJsonLdOption(ssg.jsonLd),
+		headValidation: resolveHeadValidation(ssg.headValidation),
 		readerChrome: resolveReaderChromeOption(ssg.readerChrome),
 		localeSwitcher: resolveLocaleSwitcherOption(ssg.localeSwitcher),
 		a11y: resolveA11yOption(ssg.a11y),
@@ -9329,7 +9355,9 @@ function resolveJsonLdOption(value) {
 		const publisher = resolveJsonLdPublisher(value.publisher);
 		return {
 			breadcrumbs: value.breadcrumbs !== false,
-			...publisher ? { publisher } : {}
+			...publisher ? { publisher } : {},
+			...value.type ? { type: value.type } : {},
+			...value.graph ? { graph: value.graph } : {}
 		};
 	}
 	return false;
@@ -9472,7 +9500,7 @@ function localeCodesFor(locales) {
 async function generateHtmlPage(pageData, navGroups, siteName, base, ogImage, theme, locale, availableLocales, pagination = false, readerChrome = false, breadcrumbs = false, localeSwitcher = false, localePaths, a11y = false, team = {
 	enabled: false,
 	members: []
-}, pageChrome = false, breadcrumbRootHref, jsonLd = false, siteUrl) {
+}, pageChrome = false, breadcrumbRootHref, jsonLd = false, siteUrl, headValidation = false) {
 	const mod = await require_vitepress.importNapiModule();
 	const tocForRust = pageData.toc.map(toRustTocEntry);
 	const navGroupsForRust = convertNavGroupsForRust(navGroups);
@@ -9508,7 +9536,7 @@ async function generateHtmlPage(pageData, navGroups, siteName, base, ogImage, th
 			linkText: f.linkText
 		}))
 	} : void 0;
-	return mod.generateSsgHtml({
+	const result = mod.generateSsgHtml({
 		title: pageData.title,
 		description: pageData.description,
 		content: pageData.content,
@@ -9521,12 +9549,16 @@ async function generateHtmlPage(pageData, navGroups, siteName, base, ogImage, th
 		next: pageData.next,
 		breadcrumbs: pageData.breadcrumbs,
 		layout: typeof pageData.frontmatter.layout === "string" ? pageData.frontmatter.layout : void 0,
-		chrome: pageData.chrome
+		chrome: pageData.chrome,
+		robots: typeof pageData.frontmatter.robots === "string" ? pageData.frontmatter.robots : void 0,
+		canonical: typeof pageData.frontmatter.canonical === "string" ? pageData.frontmatter.canonical : void 0
 	}, navGroupsForRust, {
 		siteName,
 		base,
 		breadcrumbRootHref,
 		ogImage,
+		siteUrl,
+		headValidation: headValidation || void 0,
 		theme: themeForRust,
 		locale,
 		availableLocales: availableLocales ? toRustLocales(availableLocales) : void 0,
@@ -9545,9 +9577,14 @@ async function generateHtmlPage(pageData, navGroups, siteName, base, ogImage, th
 		jsonLd: jsonLd ? {
 			breadcrumbs: jsonLd.breadcrumbs,
 			publisher: jsonLd.publisher,
-			siteUrl
+			siteUrl,
+			pageType: jsonLd.type,
+			graph: jsonLd.graph?.map((node) => JSON.stringify(node))
 		} : void 0
 	});
+	const html = typeof result === "string" ? result : result.html;
+	reportHeadDiagnostics(typeof result === "string" ? [] : result.diagnostics ?? [], headValidation);
+	return html;
 }
 async function externalizeSharedPageAssets(pages, outDir, base) {
 	const optimized = (await require_vitepress.importNapiModule()).externalizeSsgAssets(pages, outDir, base);
@@ -9990,7 +10027,7 @@ async function renderSsgPage(context, pageResult, collected, allPageResults) {
 	return generateHtmlPage(pageData, navItems, context.siteName, context.base, pageOgImage, theme, locale, i18n ? i18n.locales : void 0, context.ssgOptions.pagination, context.ssgOptions.readerChrome, context.ssgOptions.breadcrumbs, context.ssgOptions.localeSwitcher, localePaths, context.ssgOptions.a11y, context.ssgOptions.team ?? {
 		enabled: false,
 		members: []
-	}, context.ssgOptions.pageChrome, versionNavigation?.root.href, context.ssgOptions.jsonLd, context.ssgOptions.siteUrl);
+	}, context.ssgOptions.pageChrome, versionNavigation?.root.href, context.ssgOptions.jsonLd, context.ssgOptions.siteUrl, context.ssgOptions.headValidation);
 }
 function rewritePagerOverride(pager, context) {
 	return pager?.href ? {
@@ -10451,7 +10488,7 @@ async function renderPage$1(filePath, options, navGroups, siteName, base, root,
 	let html = await generateHtmlPage(pageData, localizedNav, siteName, base, options.ssg.ogImage, theme, locale, i18n ? i18n.locales : void 0, options.ssg.pagination, options.ssg.readerChrome, options.ssg.breadcrumbs, options.ssg.localeSwitcher, localePaths, options.ssg.a11y, options.ssg.team ?? {
 		enabled: false,
 		members: []
-	}, options.ssg.pageChrome, void 0, options.ssg.jsonLd, options.ssg.siteUrl);
+	}, options.ssg.pageChrome, void 0, options.ssg.jsonLd, options.ssg.siteUrl, options.ssg.headValidation);
 	html = injectViteHmrClient(html);
 	return html;
 }
@@ -13073,6 +13110,7 @@ exports.prefetchOgpData = prefetchOgpData;
 exports.raw = require_jsx_html.raw;
 exports.readingTimeMinutes = readingTimeMinutes;
 exports.renderAllPages = renderAllPages;
+exports.renderHead = renderHead;
 exports.renderHtmlToFrameworkCode = renderHtmlToFrameworkCode;
 exports.renderHtmlToReactComponent = renderHtmlToReactComponent;
 exports.renderHtmlToReactCreateElement = renderHtmlToReactCreateElement;
@@ -13095,6 +13133,7 @@ exports.resolveDocsOptions = resolveDocsOptions;
 exports.resolveDocumentComponentImports = resolveDocumentComponentImports;
 exports.resolveFeedsOptions = resolveFeedsOptions;
 exports.resolveFileTreeOptions = resolveFileTreeOptions;
+exports.resolveHeadValidation = resolveHeadValidation;
 exports.resolveHeaderNavItems = require_vitepress.resolveHeaderNavItems;
 exports.resolveI18nOptions = resolveI18nOptions;
 exports.resolveImageOptions = resolveImageOptions;