@rooted/markdown 1.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Marvin Brouwer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/markdown.d.mts

@@ -0,0 +1,71 @@
+import { CssClasses } from "@rooted/components";
+//#region src/markdown.d.mts
+/**
+ * What the Vite plugin turns a `.md` file into.
+ *
+ * A module namespace from `import('./about.md')` matches this shape, so it can
+ * be passed as {@link MarkdownOptions.source} directly.
+ */
+type MarkdownModule = {
+  /** The parsed YAML frontmatter block. Cast it to your own shape. */
+  frontmatter: Record<string, unknown>;
+  /** The body, rendered to HTML at build time. */
+  html: string;
+};
+/**
+ * Content for {@link Markdown}: anything with an `html` property (a transformed
+ * `.md` module), or an HTML string.
+ *
+ * A bare string is **HTML, not markdown**. There's no markdown parser in the
+ * browser bundle, on purpose. Rendering happens at build time in the Vite
+ * plugin.
+ */
+type MarkdownSource = {
+  html: string;
+} | string;
+/**
+ * Options for {@link Markdown}.
+ */
+type MarkdownOptions = {
+  /** The HTML to render, or a `.md` module to take it from. */
+  source: MarkdownSource;
+  /** Tag for the wrapping element. Defaults to `div`. */
+  tag?: keyof HTMLElementTagNameMap;
+  /** CSS classes applied to the wrapping element. */
+  classes?: CssClasses;
+};
+/**
+ * Renders pre-rendered HTML into the DOM.
+ *
+ * Pair it with the Vite plugin (`@rooted/markdown/vite`), which turns `.md`
+ * files into modules carrying an `html` export:
+ *
+ * ```ts
+ * import * as about from './about.md'
+ *
+ * append(create(Markdown, {
+ *   source: about
+ * }))
+ * ```
+ *
+ * For content that differs per locale, hand it whichever module
+ * `localization.branch` picked:
+ *
+ * ```ts
+ * const source = await localization.branch({
+ *   'en-GB': () => import('./about.en-GB.md'),
+ *   'nl-NL': () => import('./about.nl-NL.md'),
+ * })
+ * append(create(Markdown, {
+ *   source
+ * }))
+ * ```
+ *
+ * The HTML is assigned as-is and is **not sanitised**. Treat `source` the way
+ * you'd treat a `<script>` tag: fine for content you control (files in your
+ * repo, your own CMS), not for anything a visitor can influence.
+ */
+declare const Markdown: import("@rooted/components").Component<MarkdownOptions>;
+//#endregion
+export { Markdown, type MarkdownModule, type MarkdownOptions, type MarkdownSource };
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWFya2Rvd24uZC5tdHMiLCJuYW1lcyI6W10sInNvdXJjZXMiOlsiLi4vc3JjL21hcmtkb3duLm10cyJdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7S0FVWTs7RUFFWCxhQUFhOztFQUViOzs7Ozs7Ozs7O0tBV1c7RUFBbUI7Ozs7O0tBS25COztFQUVYLFFBQVE7O0VBRVIsWUFBWTs7RUFFWixVQUFVOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Y0FrQ0UsdUNBQVEsVUFBQSJ9

package/dist/markdown.mjs

@@ -0,0 +1,47 @@
+import { component } from "@rooted/components";
+//#region src/markdown.mts
+/**
+* Renders pre-rendered HTML into the DOM.
+*
+* Pair it with the Vite plugin (`@rooted/markdown/vite`), which turns `.md`
+* files into modules carrying an `html` export:
+*
+* ```ts
+* import * as about from './about.md'
+*
+* append(create(Markdown, {
+*   source: about
+* }))
+* ```
+*
+* For content that differs per locale, hand it whichever module
+* `localization.branch` picked:
+*
+* ```ts
+* const source = await localization.branch({
+*   'en-GB': () => import('./about.en-GB.md'),
+*   'nl-NL': () => import('./about.nl-NL.md'),
+* })
+* append(create(Markdown, {
+*   source
+* }))
+* ```
+*
+* The HTML is assigned as-is and is **not sanitised**. Treat `source` the way
+* you'd treat a `<script>` tag: fine for content you control (files in your
+* repo, your own CMS), not for anything a visitor can influence.
+*/
+const Markdown = component({
+	name: "@rooted/markdown",
+	onMount({ options, append, element }) {
+		const { source, tag, classes } = options;
+		append(element(tag ?? "div", {
+			classes,
+			innerHTML: typeof source === "string" ? source : source.html
+		}));
+	}
+});
+//#endregion
+export { Markdown };
+
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWFya2Rvd24ubWpzIiwibmFtZXMiOltdLCJzb3VyY2VzIjpbIi4uL3NyYy9tYXJrZG93bi5tdHMiXSwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgY29tcG9uZW50IH0gZnJvbSAnQHJvb3RlZC9jb21wb25lbnRzJ1xuXG5pbXBvcnQgdHlwZSB7IENzc0NsYXNzZXMgfSBmcm9tICdAcm9vdGVkL2NvbXBvbmVudHMnXG5cbi8qKlxuICogV2hhdCB0aGUgVml0ZSBwbHVnaW4gdHVybnMgYSBgLm1kYCBmaWxlIGludG8uXG4gKlxuICogQSBtb2R1bGUgbmFtZXNwYWNlIGZyb20gYGltcG9ydCgnLi9hYm91dC5tZCcpYCBtYXRjaGVzIHRoaXMgc2hhcGUsIHNvIGl0IGNhblxuICogYmUgcGFzc2VkIGFzIHtAbGluayBNYXJrZG93bk9wdGlvbnMuc291cmNlfSBkaXJlY3RseS5cbiAqL1xuZXhwb3J0IHR5cGUgTWFya2Rvd25Nb2R1bGUgPSB7XG5cdC8qKiBUaGUgcGFyc2VkIFlBTUwgZnJvbnRtYXR0ZXIgYmxvY2suIENhc3QgaXQgdG8geW91ciBvd24gc2hhcGUuICovXG5cdGZyb250bWF0dGVyOiBSZWNvcmQ8c3RyaW5nLCB1bmtub3duPlxuXHQvKiogVGhlIGJvZHksIHJlbmRlcmVkIHRvIEhUTUwgYXQgYnVpbGQgdGltZS4gKi9cblx0aHRtbDogc3RyaW5nXG59XG5cbi8qKlxuICogQ29udGVudCBmb3Ige0BsaW5rIE1hcmtkb3dufTogYW55dGhpbmcgd2l0aCBhbiBgaHRtbGAgcHJvcGVydHkgKGEgdHJhbnNmb3JtZWRcbiAqIGAubWRgIG1vZHVsZSksIG9yIGFuIEhUTUwgc3RyaW5nLlxuICpcbiAqIEEgYmFyZSBzdHJpbmcgaXMgKipIVE1MLCBub3QgbWFya2Rvd24qKi4gVGhlcmUncyBubyBtYXJrZG93biBwYXJzZXIgaW4gdGhlXG4gKiBicm93c2VyIGJ1bmRsZSwgb24gcHVycG9zZS4gUmVuZGVyaW5nIGhhcHBlbnMgYXQgYnVpbGQgdGltZSBpbiB0aGUgVml0ZVxuICogcGx1Z2luLlxuICovXG5leHBvcnQgdHlwZSBNYXJrZG93blNvdXJjZSA9IHsgaHRtbDogc3RyaW5nIH0gfCBzdHJpbmdcblxuLyoqXG4gKiBPcHRpb25zIGZvciB7QGxpbmsgTWFya2Rvd259LlxuICovXG5leHBvcnQgdHlwZSBNYXJrZG93bk9wdGlvbnMgPSB7XG5cdC8qKiBUaGUgSFRNTCB0byByZW5kZXIsIG9yIGEgYC5tZGAgbW9kdWxlIHRvIHRha2UgaXQgZnJvbS4gKi9cblx0c291cmNlOiBNYXJrZG93blNvdXJjZVxuXHQvKiogVGFnIGZvciB0aGUgd3JhcHBpbmcgZWxlbWVudC4gRGVmYXVsdHMgdG8gYGRpdmAuICovXG5cdHRhZz86IGtleW9mIEhUTUxFbGVtZW50VGFnTmFtZU1hcFxuXHQvKiogQ1NTIGNsYXNzZXMgYXBwbGllZCB0byB0aGUgd3JhcHBpbmcgZWxlbWVudC4gKi9cblx0Y2xhc3Nlcz86IENzc0NsYXNzZXNcbn1cblxuLyoqXG4gKiBSZW5kZXJzIHByZS1yZW5kZXJlZCBIVE1MIGludG8gdGhlIERPTS5cbiAqXG4gKiBQYWlyIGl0IHdpdGggdGhlIFZpdGUgcGx1Z2luIChgQHJvb3RlZC9tYXJrZG93bi92aXRlYCksIHdoaWNoIHR1cm5zIGAubWRgXG4gKiBmaWxlcyBpbnRvIG1vZHVsZXMgY2FycnlpbmcgYW4gYGh0bWxgIGV4cG9ydDpcbiAqXG4gKiBgYGB0c1xuICogaW1wb3J0ICogYXMgYWJvdXQgZnJvbSAnLi9hYm91dC5tZCdcbiAqXG4gKiBhcHBlbmQoY3JlYXRlKE1hcmtkb3duLCB7XG4gKiAgIHNvdXJjZTogYWJvdXRcbiAqIH0pKVxuICogYGBgXG4gKlxuICogRm9yIGNvbnRlbnQgdGhhdCBkaWZmZXJzIHBlciBsb2NhbGUsIGhhbmQgaXQgd2hpY2hldmVyIG1vZHVsZVxuICogYGxvY2FsaXphdGlvbi5icmFuY2hgIHBpY2tlZDpcbiAqXG4gKiBgYGB0c1xuICogY29uc3Qgc291cmNlID0gYXdhaXQgbG9jYWxpemF0aW9uLmJyYW5jaCh7XG4gKiAgICdlbi1HQic6ICgpID0+IGltcG9ydCgnLi9hYm91dC5lbi1HQi5tZCcpLFxuICogICAnbmwtTkwnOiAoKSA9PiBpbXBvcnQoJy4vYWJvdXQubmwtTkwubWQnKSxcbiAqIH0pXG4gKiBhcHBlbmQoY3JlYXRlKE1hcmtkb3duLCB7XG4gKiAgIHNvdXJjZVxuICogfSkpXG4gKiBgYGBcbiAqXG4gKiBUaGUgSFRNTCBpcyBhc3NpZ25lZCBhcy1pcyBhbmQgaXMgKipub3Qgc2FuaXRpc2VkKiouIFRyZWF0IGBzb3VyY2VgIHRoZSB3YXlcbiAqIHlvdSdkIHRyZWF0IGEgYDxzY3JpcHQ+YCB0YWc6IGZpbmUgZm9yIGNvbnRlbnQgeW91IGNvbnRyb2wgKGZpbGVzIGluIHlvdXJcbiAqIHJlcG8sIHlvdXIgb3duIENNUyksIG5vdCBmb3IgYW55dGhpbmcgYSB2aXNpdG9yIGNhbiBpbmZsdWVuY2UuXG4gKi9cbmV4cG9ydCBjb25zdCBNYXJrZG93biA9IGNvbXBvbmVudDxNYXJrZG93bk9wdGlvbnM+KHtcblx0bmFtZTogJ0Byb290ZWQvbWFya2Rvd24nLFxuXHRvbk1vdW50KHsgb3B0aW9ucywgYXBwZW5kLCBlbGVtZW50IH0pIHtcblx0XHRjb25zdCB7IHNvdXJjZSwgdGFnLCBjbGFzc2VzIH0gPSBvcHRpb25zXG5cblx0XHRhcHBlbmQoXG5cdFx0XHRlbGVtZW50KHRhZyA/PyAnZGl2Jywge1xuXHRcdFx0XHRjbGFzc2VzLFxuXHRcdFx0XHQvLyBUcnVzdGVkIGJ5IGNvbnRyYWN0OiB0aGUgY2FsbGVyIG93bnMgdGhpcyBIVE1MLCBzZWUgdGhlIFRTRG9jXG5cdFx0XHRcdGlubmVySFRNTDogdHlwZW9mIHNvdXJjZSA9PT0gJ3N0cmluZycgPyBzb3VyY2UgOiBzb3VyY2UuaHRtbCxcblx0XHRcdH0pLFxuXHRcdClcblx0fSxcbn0pXG4iXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQXNFQSxNQUFhLFdBQVcsVUFBMkI7Q0FDbEQsTUFBTTtDQUNOLFFBQVEsRUFBRSxTQUFTLFFBQVEsV0FBVztFQUNyQyxNQUFNLEVBQUUsUUFBUSxLQUFLLFlBQVk7RUFFakMsT0FDQyxRQUFRLE9BQU8sT0FBTztHQUNyQjtHQUVBLFdBQVcsT0FBTyxXQUFXLFdBQVcsU0FBUyxPQUFPO0VBQ3pELENBQUMsQ0FDRjtDQUNEO0FBQ0QsQ0FBQyJ9

package/dist/vite.d.mts

@@ -0,0 +1,43 @@
+import { Plugin } from "vite";
+//#region plugins/markdown.d.mts
+/**
+ * Options for {@link rootedMarkdown}.
+ */
+type MarkdownPluginOptions = {
+  /**
+   * Minify the rendered HTML. Defaults to `true` for builds and `false` for
+   * the dev server, so what you read in devtools matches the source.
+   */
+  minify?: boolean;
+};
+/**
+ * Turns `.md` files into modules at build time, so no markdown parser reaches
+ * the browser bundle.
+ *
+ * Each file becomes `frontmatter` (whatever the YAML block contained) and
+ * `html` (everything after it, rendered by `marked`), exported both by name
+ * and as a default:
+ *
+ * ```ts
+ * import { frontmatter, html } from './about.md'
+ * ```
+ *
+ * Because `html` is a named export, the module itself satisfies the `Markdown`
+ * component's `source`, so you can hand a dynamic import straight over:
+ *
+ * ```ts
+ * append(create(Markdown, {
+ *   source: await import('./about.md')
+ * }))
+ * ```
+ *
+ * Imports carrying a query (`./about.md?raw`, `?url`) are left alone for Vite
+ * to handle.
+ *
+ * Reference `@rooted/markdown/vite/types` from your env declarations so
+ * TypeScript knows what a `.md` import is.
+ */
+declare function rootedMarkdown(options?: MarkdownPluginOptions): Plugin;
+//#endregion
+export { type MarkdownPluginOptions, rootedMarkdown };
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidml0ZS5kLm10cyIsIm5hbWVzIjpbXSwic291cmNlcyI6WyIuLi9wbHVnaW5zL21hcmtkb3duLm10cyJdLCJtYXBwaW5ncyI6Ijs7Ozs7S0FTWTs7Ozs7RUFLWDs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7aUJBcUNlLGVBQWUsVUFBUyx3QkFBNkIifQ==

package/dist/vite.mjs

@@ -0,0 +1,65 @@
+import matter from "gray-matter";
+import { Marked } from "marked";
+//#region plugins/markdown.mts
+const minifyOptions = {
+	collapseWhitespace: true,
+	removeComments: true,
+	removeOptionalTags: true,
+	decodeEntities: true
+};
+/**
+* Turns `.md` files into modules at build time, so no markdown parser reaches
+* the browser bundle.
+*
+* Each file becomes `frontmatter` (whatever the YAML block contained) and
+* `html` (everything after it, rendered by `marked`), exported both by name
+* and as a default:
+*
+* ```ts
+* import { frontmatter, html } from './about.md'
+* ```
+*
+* Because `html` is a named export, the module itself satisfies the `Markdown`
+* component's `source`, so you can hand a dynamic import straight over:
+*
+* ```ts
+* append(create(Markdown, {
+*   source: await import('./about.md')
+* }))
+* ```
+*
+* Imports carrying a query (`./about.md?raw`, `?url`) are left alone for Vite
+* to handle.
+*
+* Reference `@rooted/markdown/vite/types` from your env declarations so
+* TypeScript knows what a `.md` import is.
+*/
+function rootedMarkdown(options = {}) {
+	const marked = new Marked();
+	let config;
+	return {
+		name: "vite-plugin:rooted-markdown",
+		configResolved(resolvedConfig) {
+			config = resolvedConfig;
+		},
+		async transform(code, id) {
+			const [file, query] = id.split("?");
+			if (query !== void 0 || !file.endsWith(".md")) return;
+			const { data, content } = matter(code);
+			const rendered = await marked.parse(content);
+			const html = options.minify ?? config.command === "build" ? await (await import("html-minifier-terser")).minify(rendered, minifyOptions) : rendered;
+			return {
+				code: [
+					`export const frontmatter = ${JSON.stringify(data)}`,
+					`export const html = ${JSON.stringify(html)}`,
+					"export default { frontmatter, html }"
+				].join("\n"),
+				map: void 0
+			};
+		}
+	};
+}
+//#endregion
+export { rootedMarkdown };
+
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidml0ZS5tanMiLCJuYW1lcyI6W10sInNvdXJjZXMiOlsiLi4vcGx1Z2lucy9tYXJrZG93bi5tdHMiXSwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IG1hdHRlciBmcm9tICdncmF5LW1hdHRlcidcbmltcG9ydCB7IE1hcmtlZCB9IGZyb20gJ21hcmtlZCdcblxuaW1wb3J0IHR5cGUgeyBPcHRpb25zIGFzIE1pbmlmeU9wdGlvbnMgfSBmcm9tICdodG1sLW1pbmlmaWVyLXRlcnNlcidcbmltcG9ydCB0eXBlIHsgUGx1Z2luLCBSZXNvbHZlZENvbmZpZyB9IGZyb20gJ3ZpdGUnXG5cbi8qKlxuICogT3B0aW9ucyBmb3Ige0BsaW5rIHJvb3RlZE1hcmtkb3dufS5cbiAqL1xuZXhwb3J0IHR5cGUgTWFya2Rvd25QbHVnaW5PcHRpb25zID0ge1xuXHQvKipcblx0ICogTWluaWZ5IHRoZSByZW5kZXJlZCBIVE1MLiBEZWZhdWx0cyB0byBgdHJ1ZWAgZm9yIGJ1aWxkcyBhbmQgYGZhbHNlYCBmb3Jcblx0ICogdGhlIGRldiBzZXJ2ZXIsIHNvIHdoYXQgeW91IHJlYWQgaW4gZGV2dG9vbHMgbWF0Y2hlcyB0aGUgc291cmNlLlxuXHQgKi9cblx0bWluaWZ5PzogYm9vbGVhblxufVxuXG5jb25zdCBtaW5pZnlPcHRpb25zOiBNaW5pZnlPcHRpb25zID0ge1xuXHRjb2xsYXBzZVdoaXRlc3BhY2U6IHRydWUsXG5cdHJlbW92ZUNvbW1lbnRzOiB0cnVlLFxuXHRyZW1vdmVPcHRpb25hbFRhZ3M6IHRydWUsXG5cdGRlY29kZUVudGl0aWVzOiB0cnVlLFxufVxuXG4vKipcbiAqIFR1cm5zIGAubWRgIGZpbGVzIGludG8gbW9kdWxlcyBhdCBidWlsZCB0aW1lLCBzbyBubyBtYXJrZG93biBwYXJzZXIgcmVhY2hlc1xuICogdGhlIGJyb3dzZXIgYnVuZGxlLlxuICpcbiAqIEVhY2ggZmlsZSBiZWNvbWVzIGBmcm9udG1hdHRlcmAgKHdoYXRldmVyIHRoZSBZQU1MIGJsb2NrIGNvbnRhaW5lZCkgYW5kXG4gKiBgaHRtbGAgKGV2ZXJ5dGhpbmcgYWZ0ZXIgaXQsIHJlbmRlcmVkIGJ5IGBtYXJrZWRgKSwgZXhwb3J0ZWQgYm90aCBieSBuYW1lXG4gKiBhbmQgYXMgYSBkZWZhdWx0OlxuICpcbiAqIGBgYHRzXG4gKiBpbXBvcnQgeyBmcm9udG1hdHRlciwgaHRtbCB9IGZyb20gJy4vYWJvdXQubWQnXG4gKiBgYGBcbiAqXG4gKiBCZWNhdXNlIGBodG1sYCBpcyBhIG5hbWVkIGV4cG9ydCwgdGhlIG1vZHVsZSBpdHNlbGYgc2F0aXNmaWVzIHRoZSBgTWFya2Rvd25gXG4gKiBjb21wb25lbnQncyBgc291cmNlYCwgc28geW91IGNhbiBoYW5kIGEgZHluYW1pYyBpbXBvcnQgc3RyYWlnaHQgb3ZlcjpcbiAqXG4gKiBgYGB0c1xuICogYXBwZW5kKGNyZWF0ZShNYXJrZG93biwge1xuICogICBzb3VyY2U6IGF3YWl0IGltcG9ydCgnLi9hYm91dC5tZCcpXG4gKiB9KSlcbiAqIGBgYFxuICpcbiAqIEltcG9ydHMgY2FycnlpbmcgYSBxdWVyeSAoYC4vYWJvdXQubWQ/cmF3YCwgYD91cmxgKSBhcmUgbGVmdCBhbG9uZSBmb3IgVml0ZVxuICogdG8gaGFuZGxlLlxuICpcbiAqIFJlZmVyZW5jZSBgQHJvb3RlZC9tYXJrZG93bi92aXRlL3R5cGVzYCBmcm9tIHlvdXIgZW52IGRlY2xhcmF0aW9ucyBzb1xuICogVHlwZVNjcmlwdCBrbm93cyB3aGF0IGEgYC5tZGAgaW1wb3J0IGlzLlxuICovXG5leHBvcnQgZnVuY3Rpb24gcm9vdGVkTWFya2Rvd24ob3B0aW9uczogTWFya2Rvd25QbHVnaW5PcHRpb25zID0ge30pOiBQbHVnaW4ge1xuXHQvLyBBIHByaXZhdGUgaW5zdGFuY2U6IGBtYXJrZWQudXNlKC4uLilgIG11dGF0ZXMgYSBzaGFyZWQgc2luZ2xldG9uLCB3aGljaFxuXHQvLyB3b3VsZCBsZWFrIGludG8gYW55dGhpbmcgZWxzZSBpbiB0aGUgYXBwIHRoYXQgdXNlcyBtYXJrZWQuXG5cdGNvbnN0IG1hcmtlZCA9IG5ldyBNYXJrZWQoKVxuXHRsZXQgY29uZmlnOiBSZXNvbHZlZENvbmZpZ1xuXG5cdHJldHVybiB7XG5cdFx0bmFtZTogJ3ZpdGUtcGx1Z2luOnJvb3RlZC1tYXJrZG93bicsXG5cdFx0Y29uZmlnUmVzb2x2ZWQocmVzb2x2ZWRDb25maWcpIHtcblx0XHRcdGNvbmZpZyA9IHJlc29sdmVkQ29uZmlnXG5cdFx0fSxcblx0XHRhc3luYyB0cmFuc2Zvcm0oY29kZSwgaWQpIHtcblx0XHRcdGNvbnN0IFtmaWxlLCBxdWVyeV0gPSBpZC5zcGxpdCgnPycpXG5cdFx0XHQvLyBBIHF1ZXJ5IG1lYW5zIHRoZSBjYWxsZXIgYXNrZWQgVml0ZSBmb3Igc29tZXRoaW5nIHNwZWNpZmljICg/cmF3LCA/dXJsKVxuXHRcdFx0aWYgKHF1ZXJ5ICE9PSB1bmRlZmluZWQgfHwgIWZpbGUuZW5kc1dpdGgoJy5tZCcpKSByZXR1cm5cblxuXHRcdFx0Y29uc3QgeyBkYXRhLCBjb250ZW50IH0gPSBtYXR0ZXIoY29kZSlcblx0XHRcdGNvbnN0IHJlbmRlcmVkID0gYXdhaXQgbWFya2VkLnBhcnNlKGNvbnRlbnQpXG5cdFx0XHRjb25zdCBzaG91bGRNaW5pZnkgPSBvcHRpb25zLm1pbmlmeSA/PyBjb25maWcuY29tbWFuZCA9PT0gJ2J1aWxkJ1xuXHRcdFx0Y29uc3QgaHRtbCA9IHNob3VsZE1pbmlmeVxuXHRcdFx0XHQ/IGF3YWl0IChhd2FpdCBpbXBvcnQoJ2h0bWwtbWluaWZpZXItdGVyc2VyJykpLm1pbmlmeShyZW5kZXJlZCwgbWluaWZ5T3B0aW9ucylcblx0XHRcdFx0OiByZW5kZXJlZFxuXG5cdFx0XHRjb25zdCBmcm9udG1hdHRlciA9IEpTT04uc3RyaW5naWZ5KGRhdGEpXG5cdFx0XHRyZXR1cm4ge1xuXHRcdFx0XHRjb2RlOiBbXG5cdFx0XHRcdFx0YGV4cG9ydCBjb25zdCBmcm9udG1hdHRlciA9ICR7ZnJvbnRtYXR0ZXJ9YCxcblx0XHRcdFx0XHRgZXhwb3J0IGNvbnN0IGh0bWwgPSAke0pTT04uc3RyaW5naWZ5KGh0bWwpfWAsXG5cdFx0XHRcdFx0J2V4cG9ydCBkZWZhdWx0IHsgZnJvbnRtYXR0ZXIsIGh0bWwgfScsXG5cdFx0XHRcdF0uam9pbignXFxuJyksXG5cdFx0XHRcdG1hcDogdW5kZWZpbmVkLFxuXHRcdFx0fVxuXHRcdH0sXG5cdH1cbn1cbiJdLCJtYXBwaW5ncyI6Ijs7O0FBaUJBLE1BQU0sZ0JBQStCO0NBQ3BDLG9CQUFvQjtDQUNwQixnQkFBZ0I7Q0FDaEIsb0JBQW9CO0NBQ3BCLGdCQUFnQjtBQUNqQjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQTZCQSxTQUFnQixlQUFlLFVBQWlDLENBQUMsR0FBVztDQUczRSxNQUFNLFNBQVMsSUFBSSxPQUFPO0NBQzFCLElBQUk7Q0FFSixPQUFPO0VBQ04sTUFBTTtFQUNOLGVBQWUsZ0JBQWdCO0dBQzlCLFNBQVM7RUFDVjtFQUNBLE1BQU0sVUFBVSxNQUFNLElBQUk7R0FDekIsTUFBTSxDQUFDLE1BQU0sU0FBUyxHQUFHLE1BQU0sR0FBRztHQUVsQyxJQUFJLFVBQVUsS0FBQSxLQUFhLENBQUMsS0FBSyxTQUFTLEtBQUssR0FBRztHQUVsRCxNQUFNLEVBQUUsTUFBTSxZQUFZLE9BQU8sSUFBSTtHQUNyQyxNQUFNLFdBQVcsTUFBTSxPQUFPLE1BQU0sT0FBTztHQUUzQyxNQUFNLE9BRGUsUUFBUSxVQUFVLE9BQU8sWUFBWSxVQUV2RCxPQUFPLE1BQU0sT0FBTyx3QkFBQSxDQUF5QixPQUFPLFVBQVUsYUFBYSxJQUMzRTtHQUdILE9BQU87SUFDTixNQUFNO0tBQ0wsOEJBSGtCLEtBQUssVUFBVSxJQUdPO0tBQ3hDLHVCQUF1QixLQUFLLFVBQVUsSUFBSTtLQUMxQztJQUNELENBQUMsQ0FBQyxLQUFLLElBQUk7SUFDWCxLQUFLLEtBQUE7R0FDTjtFQUNEO0NBQ0Q7QUFDRCJ9

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@rooted/markdown",
+  "version": "1.0.0-alpha.0",
+  "description": "Markdown content for the rooted framework",
+  "keywords": [
+    "markdown",
+    "marked",
+    "frontmatter",
+    "vite-plugin",
+    "web-components",
+    "typescript",
+    "rooted"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Marvin-Brouwer/rooted.git",
+    "directory": "packages/markdown"
+  },
+  "homepage": "https://github.com/Marvin-Brouwer/rooted#readme",
+  "bugs": "https://github.com/Marvin-Brouwer/rooted/issues",
+  "sideEffects": false,
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public",
+    "provenance": true
+  },
+  "files": [
+    "dist",
+    "plugins/markdown.d.ts",
+    "readme.md"
+  ],
+  "engines": {
+    "node": ">=22.0.0",
+    "pnpm": ">=10.0.0"
+  },
+  "exports": {
+    ".": {
+      "source": "./src/_module/markdown.mts",
+      "import": "./dist/markdown.mjs",
+      "types": "./dist/markdown.d.mts"
+    },
+    "./vite": {
+      "source": "./plugins/_module/vite.mts",
+      "import": "./dist/vite.mjs",
+      "types": "./dist/vite.d.mts"
+    },
+    "./vite/types": {
+      "types": "./plugins/markdown.d.ts"
+    }
+  },
+  "dependencies": {
+    "gray-matter": "^4.0.3",
+    "html-minifier-terser": "^7.2.0",
+    "marked": "^18.0.5"
+  },
+  "peerDependencies": {
+    "vite": ">=8.0.1",
+    "@rooted/components": "^1.0.0-alpha.0"
+  },
+  "devDependencies": {
+    "@types/html-minifier-terser": "^7.0.2",
+    "@types/node": "^26.2.0",
+    "vite": "^8.2.1",
+    "@rooted/development": "0.1.0",
+    "@rooted/components": "^1.0.0-alpha.0"
+  },
+  "scripts": {
+    "build": "pnpm build:ci",
+    "build:dev": "pnpm build:ci && rooted-development extract-api",
+    "build:ci": "tsdown",
+    "watch": "tsdown --watch --no-clean",
+    "clean": "rm -rf dist",
+    "extract-api": "rooted-development extract-api"
+  }
+}

package/plugins/markdown.d.ts

@@ -0,0 +1,9 @@
+declare module '*.md' {
+	/** The parsed YAML frontmatter block. Cast it to your own shape. */
+	export const frontmatter: Record<string, unknown>
+	/** The body, rendered to HTML at build time. */
+	export const html: string
+
+	const markdown: import('@rooted/markdown').MarkdownModule
+	export default markdown
+}

package/readme.md

@@ -0,0 +1,38 @@
+# [`@rooted/markdown`](https://www.npmjs.com/package/@rooted/markdown)
+
+Markdown content for the [`@rooted/*`](https://github.com/Marvin-Brouwer/rooted#rooted) framework. A Vite plugin renders `.md` files to HTML at build time, and a component puts that HTML in the DOM. No markdown parser reaches the browser bundle.
+
+> [!IMPORTANT]
+> This package is still in alpha.
+
+```sh
+pnpm add @rooted/markdown
+```
+
+Register the plugin:
+
+```ts
+import { rootedMarkdown } from '@rooted/markdown/vite'
+
+export default rootedManifest({
+  plugins: [rootedMarkdown()],
+})
+```
+
+Add the ambient types to your env declarations so `.md` imports typecheck:
+
+```ts
+/// <reference types="@rooted/markdown/vite/types" />
+```
+
+Then import a file and render it:
+
+```ts
+import * as about from './about.md'
+
+append(create(Markdown, { source: about }))
+```
+
+`about.frontmatter` holds the YAML block. The component assigns `html` as-is and does not sanitise it, so only pass content you control.
+
+More in the [markdown guide](https://github.com/Marvin-Brouwer/rooted/blob/main/docs/guide/markdown.md).