@void/md 0.26.0 → 0.27.0

package/README.md

@@ -1,6 +1,6 @@
 # @void/md
 
-Add Markdown routes to Void Pages with frontmatter, syntax highlighting, layouts, and interactive islands.
+Markdown adapter for [Void](https://void.cloud). Build content pages with frontmatter, syntax highlighting, layouts, and interactive islands alongside your application routes.
 
 ## Setup
 
@@ -13,10 +13,10 @@ npm install @void/md
 Add `voidMarkdown()` after the adapter in your Vite config. For example, with Vue:
 
 ```ts
+import { voidMarkdown } from '@void/md/plugin';
+import { voidVue } from '@void/vue/plugin';
 import { defineConfig } from 'vite';
 import { voidPlugin } from 'void';
-import { voidVue } from '@void/vue/plugin';
-import { voidMarkdown } from '@void/md/plugin';
 
 export default defineConfig({
   plugins: [voidPlugin(), voidVue(), voidMarkdown()],
@@ -25,4 +25,8 @@ export default defineConfig({
 
 Create `.md` files in `pages/`. The plugin also works with React, Svelte, and Solid.
 
-See [Markdown](https://void.cloud/guide/pages-routing/markdown) for frontmatter, themes, navigation, and plugin options, and [Islands](https://void.cloud/guide/pages-routing/islands) for interactive components. Repository verification is documented in [TESTING.md](../../TESTING.md).
+## Documentation
+
+See [Markdown](https://void.cloud/guide/pages-routing/markdown) for frontmatter, themes, navigation, and plugin options, and [Islands](https://void.cloud/guide/pages-routing/islands) for interactive components.
+
+Read the [Void documentation](https://void.cloud) online or use the Markdown guides and references in `node_modules/void/docs/`, included with the `void` package.

package/dist/{compile-DiIM3f5f.mjs → compile-BwShiv84.mjs}

@@ -1,3 +1,4 @@
+import { t as extractHeadings } from "./metadata-TdHmXD-i.mjs";
 import matter from "gray-matter";
 import MarkdownExit from "markdown-exit";
 import anchor from "markdown-it-anchor";
@@ -220,30 +221,8 @@ function tocPlugin(md, options) {
 		"reference",
 		"blockquote"
 	] });
-	md.renderer.rules.toc_open = (tokens, idx, options, _env, self) => {
-		return self.renderToken(tokens, idx, options);
-	};
 	md.renderer.rules.toc_body = (tokens) => {
-		const headers = [];
-		for (let tokenIndex = 0; tokenIndex < tokens.length; tokenIndex++) {
-			const token = tokens[tokenIndex];
-			if (token.type === "heading_open") {
-				const depth = Number(token.tag.slice(1));
-				if (level.includes(depth)) {
-					const slug = token.attrGet?.("id") ?? "";
-					const text = (tokens[tokenIndex + 1]?.children?.filter((child) => child.type === "text" || child.type === "code_inline").map((child) => child.content).join("") ?? "").trim();
-					headers.push({
-						depth,
-						slug,
-						text
-					});
-				}
-			}
-		}
-		return renderHeaders(headers, listTag);
-	};
-	md.renderer.rules.toc_close = (tokens, idx, options, _env, self) => {
-		return self.renderToken(tokens, idx, options);
+		return renderHeaders(extractHeadings(tokens).filter((heading) => level.includes(heading.depth)), listTag);
 	};
 }
 //#endregion
@@ -312,27 +291,11 @@ async function createCompiler(options) {
 	markdown.use(tocPlugin);
 	return markdown;
 }
-function extractHeadings(tokens) {
-	const headings = [];
-	for (let tokenIndex = 0; tokenIndex < tokens.length; tokenIndex++) {
-		const token = tokens[tokenIndex];
-		if (token.type === "heading_open") {
-			const depth = Number(token.tag.slice(1));
-			const slug = token.attrGet?.("id") ?? "";
-			const text = (tokens[tokenIndex + 1]?.children?.filter((child) => child.type === "text" || child.type === "code_inline").map((child) => child.content).join("") ?? "").trim();
-			headings.push({
-				depth,
-				slug,
-				text
-			});
-		}
-	}
-	return headings;
-}
 async function compile(source, options) {
 	const { data: frontmatter, content } = matter(source);
 	const compiler = await getCompiler(options);
-	const headings = extractHeadings(compiler.parse(content, {}));
+	const tokens = compiler.parse(content, {});
+	const headings = extractHeadings(tokens);
 	return {
 		html: await compiler.renderAsync(content, {}),
 		frontmatter,

package/dist/metadata-TdHmXD-i.mjs

@@ -0,0 +1,45 @@
+import matter from "gray-matter";
+import MarkdownExit from "markdown-exit";
+import anchor from "markdown-it-anchor";
+import footnote from "markdown-it-footnote";
+//#region src/metadata.ts
+let metadataCompiler = null;
+function getMetadataCompiler() {
+	if (metadataCompiler) return metadataCompiler;
+	const markdown = new MarkdownExit({
+		html: true,
+		linkify: true
+	});
+	markdown.use(footnote);
+	markdown.use(anchor, { permalink: anchor.permalink.ariaHidden({ placement: "before" }) });
+	metadataCompiler = markdown;
+	return markdown;
+}
+function extractHeadings(tokens) {
+	const headings = [];
+	for (let tokenIndex = 0; tokenIndex < tokens.length; tokenIndex++) {
+		const token = tokens[tokenIndex];
+		if (token.type === "heading_open") {
+			const depth = Number(token.tag.slice(1));
+			const slug = token.attrGet?.("id") ?? "";
+			const text = (tokens[tokenIndex + 1]?.children?.filter((child) => child.type === "text" || child.type === "code_inline").map((child) => child.content).join("") ?? "").trim();
+			headings.push({
+				depth,
+				slug,
+				text
+			});
+		}
+	}
+	return headings;
+}
+function extractMetadata(source) {
+	const { data: frontmatter, content } = matter(source);
+	const headings = extractHeadings(getMetadataCompiler().parse(content, {}));
+	return {
+		frontmatter,
+		headings,
+		title: frontmatter.title ?? headings.find((heading) => heading.depth === 1)?.text ?? ""
+	};
+}
+//#endregion
+export { extractMetadata as n, extractHeadings as t };

package/dist/plugin.mjs

@@ -1,3 +1,4 @@
+import { n as extractMetadata } from "./metadata-TdHmXD-i.mjs";
 import { createHash } from "node:crypto";
 import { existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from "node:fs";
 import { dirname, join, relative, resolve } from "pathslash";
@@ -5,10 +6,6 @@ import { glob } from "tinyglobby";
 import { normalizePath } from "vite";
 import { resolvePagesDir } from "void/pages";
 import { editIslandSource, findIslandImports } from "void/pages-islands-plugin";
-import matter from "gray-matter";
-import MarkdownExit from "markdown-exit";
-import anchor from "markdown-it-anchor";
-import footnote from "markdown-it-footnote";
 //#region src/codegen/md-types.ts
 /**
 * Generate .void/md.d.ts content.
@@ -34,12 +31,12 @@ function generateMdTypes() {
 }
 //#endregion
 //#region src/emit-shared.ts
-const ISLAND_TAG_RE$1 = /<([A-Z]\w*)\s*((?:[^>/"']|"[^"]*"|'[^']*')*)\/\s*>|<([A-Z]\w*)\s*((?:[^>/"']|"[^"]*"|'[^']*')*)>([\s\S]*?)<\/\3\s*>/g;
-function findIslandTags$1(html, names) {
+const ISLAND_TAG_RE = /<([A-Z]\w*)\s*((?:[^>/"']|"[^"]*"|'[^']*')*)\/\s*>|<([A-Z]\w*)\s*((?:[^>/"']|"[^"]*"|'[^']*')*)>([\s\S]*?)<\/\3\s*>/g;
+function findIslandTags(html, names) {
 	const matches = [];
 	let match;
-	ISLAND_TAG_RE$1.lastIndex = 0;
-	while ((match = ISLAND_TAG_RE$1.exec(html)) !== null) {
+	ISLAND_TAG_RE.lastIndex = 0;
+	while ((match = ISLAND_TAG_RE.exec(html)) !== null) {
 		const name = match[1] ?? match[3];
 		if (names.has(name)) matches.push({
 			name,
@@ -50,7 +47,7 @@ function findIslandTags$1(html, names) {
 	}
 	return matches;
 }
-function parseAttrs$1(attrStr) {
+function parseAttrs(attrStr) {
 	const result = {};
 	const attrRe = /(\w[\w-]*)(?:\s*=\s*(?:"([^"]*)"|'([^']*)'|(\S+)))?/g;
 	let match;
@@ -62,7 +59,7 @@ function toIslandId(imp) {
 }
 function buildRenderChunks(html, islandImports) {
 	const islandByName = new Map(islandImports.map((item) => [item.name, item]));
-	const tags = findIslandTags$1(html, new Set(islandByName.keys()));
+	const tags = findIslandTags(html, new Set(islandByName.keys()));
 	const chunks = [];
 	let cursor = 0;
 	for (const tag of tags) {
@@ -77,7 +74,7 @@ function buildRenderChunks(html, islandImports) {
 		if (islandImport) chunks.push({
 			type: "island",
 			islandImport,
-			props: parseAttrs$1(tag.attrs)
+			props: parseAttrs(tag.attrs)
 		});
 		cursor = tag.end;
 	}
@@ -318,33 +315,8 @@ export default defineComponent({
 });
 `;
 }
-const ISLAND_TAG_RE = /<([A-Z]\w*)\s*((?:[^>/"']|"[^"]*"|'[^']*')*)\/\s*>|<([A-Z]\w*)\s*((?:[^>/"']|"[^"]*"|'[^']*')*)>([\s\S]*?)<\/\3\s*>/g;
-function findIslandTags(html, names) {
-	const matches = [];
-	let tagMatch;
-	ISLAND_TAG_RE.lastIndex = 0;
-	while ((tagMatch = ISLAND_TAG_RE.exec(html)) !== null) {
-		const name = tagMatch[1] ?? tagMatch[3];
-		if (names.has(name)) matches.push({
-			name,
-			start: tagMatch.index,
-			end: tagMatch.index + tagMatch[0].length,
-			attrs: (tagMatch[2] ?? tagMatch[4] ?? "").trim(),
-			children: tagMatch[5] ?? ""
-		});
-	}
-	return matches;
-}
-function parseAttrs(attrStr) {
-	const result = {};
-	const attrRe = /(\w[\w-]*)(?:\s*=\s*(?:"([^"]*)"|'([^']*)'|(\S+)))?/g;
-	let attrMatch;
-	while ((attrMatch = attrRe.exec(attrStr)) !== null) result[attrMatch[1]] = attrMatch[2] ?? attrMatch[3] ?? attrMatch[4] ?? "";
-	return result;
-}
 function emitVueComponentWithIslands(result, islandImports) {
-	const nameSet = new Set(islandImports.map((islandImport) => islandImport.name));
-	const islandTags = findIslandTags(result.html, nameSet);
+	const chunks = buildRenderChunks(result.html, islandImports);
 	let code = `import { defineComponent, h, createStaticVNode, provide } from "vue";\n`;
 	for (let islandIndex = 0; islandIndex < islandImports.length; islandIndex++) {
 		const islandImport = islandImports[islandIndex];
@@ -362,20 +334,10 @@ function emitVueComponentWithIslands(result, islandImports) {
 }};\n`;
 	}
 	const vnodes = [];
-	let cursor = 0;
-	for (const tag of islandTags) {
-		if (tag.start > cursor) {
-			const segment = result.html.slice(cursor, tag.start);
-			if (segment.trim()) vnodes.push(`createStaticVNode(${JSON.stringify(segment)}, 1)`);
-		}
-		const attrs = parseAttrs(tag.attrs);
-		const propsStr = Object.keys(attrs).length > 0 ? JSON.stringify(attrs) : "null";
-		vnodes.push(`h(${tag.name}, ${propsStr})`);
-		cursor = tag.end;
-	}
-	if (cursor < result.html.length) {
-		const segment = result.html.slice(cursor);
-		if (segment.trim()) vnodes.push(`createStaticVNode(${JSON.stringify(segment)}, 1)`);
+	for (const chunk of chunks) if (chunk.type === "html") vnodes.push(`createStaticVNode(${JSON.stringify(chunk.html)}, 1)`);
+	else {
+		const propsStr = Object.keys(chunk.props).length > 0 ? JSON.stringify(chunk.props) : "null";
+		vnodes.push(`h(${chunk.islandImport.name}, ${propsStr})`);
 	}
 	code += `
 const __frontmatter = ${JSON.stringify(result.frontmatter)};
@@ -425,46 +387,6 @@ function extractScript(source) {
 	};
 }
 //#endregion
-//#region src/metadata.ts
-let metadataCompiler = null;
-function getMetadataCompiler() {
-	if (metadataCompiler) return metadataCompiler;
-	const markdown = new MarkdownExit({
-		html: true,
-		linkify: true
-	});
-	markdown.use(footnote);
-	markdown.use(anchor, { permalink: anchor.permalink.ariaHidden({ placement: "before" }) });
-	metadataCompiler = markdown;
-	return markdown;
-}
-function extractHeadings(tokens) {
-	const headings = [];
-	for (let tokenIndex = 0; tokenIndex < tokens.length; tokenIndex++) {
-		const token = tokens[tokenIndex];
-		if (token.type === "heading_open") {
-			const depth = Number(token.tag.slice(1));
-			const slug = token.attrGet?.("id") ?? "";
-			const text = (tokens[tokenIndex + 1]?.children?.filter((child) => child.type === "text" || child.type === "code_inline").map((child) => child.content).join("") ?? "").trim();
-			headings.push({
-				depth,
-				slug,
-				text
-			});
-		}
-	}
-	return headings;
-}
-function extractMetadata(source) {
-	const { data: frontmatter, content } = matter(source);
-	const headings = extractHeadings(getMetadataCompiler().parse(content, {}));
-	return {
-		frontmatter,
-		headings,
-		title: frontmatter.title ?? headings.find((heading) => heading.depth === 1)?.text ?? ""
-	};
-}
-//#endregion
 //#region src/plugin.ts
 const MD_CLIENT_ENTRY_ID = "virtual:void-md-client";
 const ADAPTER_PLUGIN_NAMES = {
@@ -475,6 +397,9 @@ const ADAPTER_PLUGIN_NAMES = {
 };
 const SVELTE_VIRTUAL_PREFIX = "/@void-md-svelte/";
 const SOLID_VIRTUAL_PREFIX = "/@void-md-solid/";
+function stripPageSuffix(file) {
+	return file.replace(/\.md$/, "").replace(/\/index$/, "").replace(/^index$/, "");
+}
 function hasMdFilesWithScript(dir) {
 	try {
 		for (const entry of readdirSync(dir, {
@@ -514,10 +439,11 @@ function voidMarkdown(options) {
 		return (await Promise.all(mdFiles.map(async (file) => {
 			const { body, clientCode } = extractScript(readFileSync(join(pagesDir, file), "utf-8"));
 			const result = extractMetadata(body);
-			const componentId = file.replace(/\.md$/, "").replace(/\/index$/, "").replace(/^index$/, "") || "index";
+			const routeName = stripPageSuffix(file);
+			const componentId = routeName || "index";
 			if (clientCode) clientScripts.set(componentId, clientCode);
 			return {
-				path: "/" + file.replace(/\.md$/, "").replace(/\/index$/, "").replace(/^index$/, "") || "/",
+				path: "/" + routeName,
 				title: result.title,
 				frontmatter: result.frontmatter,
 				headings: result.headings
@@ -536,9 +462,6 @@ function voidMarkdown(options) {
 			clientEntryId: MD_CLIENT_ENTRY_ID,
 			getClientScripts() {
 				return clientScripts;
-			},
-			getClientScriptIds() {
-				return new Set(clientScripts.keys());
 			}
 		},
 		config(config, env) {
@@ -648,14 +571,14 @@ export function useFrontmatter() { return useContext(FrontmatterContext) ?? {};
 				const { body, islandImports, clientCode } = extractScript(code);
 				const pagesPrefix = pagesDir + "/";
 				if (_id.startsWith(pagesPrefix) && clientCode) {
-					const componentId = _id.slice(pagesPrefix.length).replace(/\.md$/, "").replace(/\/index$/, "").replace(/^index$/, "") || "index";
+					const componentId = stripPageSuffix(_id.slice(pagesPrefix.length)) || "index";
 					clientScripts.set(componentId, clientCode);
 				}
 				for (const imp of islandImports) {
 					const absPath = resolve(dirname(_id), imp.specifier);
 					imp.islandId = normalizePath(relative(root, absPath)).replace(/\.[^.]+$/, "");
 				}
-				const { compile } = await import("./compile-DiIM3f5f.mjs");
+				const { compile } = await import("./compile-BwShiv84.mjs");
 				const result = await compile(body, { shiki: options?.shiki });
 				if (adapter === "vue") {
 					if (islandImports.length > 0) return {

package/dist/theme/reset.css

@@ -28,14 +28,7 @@ html {
 /* Body */
 body {
   min-height: 100dvh;
-  font-family:
-    system-ui,
-    -apple-system,
-    'Segoe UI',
-    Roboto,
-    'Helvetica Neue',
-    Arial,
-    sans-serif;
+  font-family: system-ui, -apple-system, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
   -webkit-font-smoothing: antialiased;
   -moz-osx-font-smoothing: grayscale;
   text-rendering: optimizeLegibility;

package/package.json

@@ -1,6 +1,12 @@
 {
   "name": "@void/md",
-  "version": "0.26.0",
+  "version": "0.27.0",
+  "description": "Markdown pages with layouts and interactive islands for Void.",
+  "homepage": "https://void.cloud",
+  "bugs": {
+    "url": "https://github.com/voidzero-dev/void/issues"
+  },
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/voidzero-dev/void.git",
@@ -33,7 +39,7 @@
     "@shikijs/engine-javascript": "^4.5.0",
     "@shikijs/transformers": "^4.5.0",
     "gray-matter": "^4.0.3",
-    "markdown-exit": "1.3.0",
+    "markdown-exit": "^1.3.0",
     "markdown-it-anchor": "^10.0.0",
     "markdown-it-attrs": "^5.0.1",
     "markdown-it-container": "^4.0.0",
@@ -45,14 +51,14 @@
   },
   "devDependencies": {
     "@types/node": "^26.6.4",
-    "vite": "npm:@voidzero-dev/vite-plus-core@1.0.0",
-    "vite-plus": "1.0.0",
-    "void": "0.26.0",
+    "vite": "npm:@voidzero-dev/vite-plus-core@1.1.0",
+    "vite-plus": "1.1.0",
+    "void": "0.27.0",
     "vue": "^3.5.43"
   },
   "peerDependencies": {
     "vite": "^8.0.0",
-    "void": "0.26.0"
+    "void": "0.27.0"
   },
   "scripts": {
     "build": "vp pack",