starlight-dot-md 0.1.2 → 0.2.1

package/README.md

@@ -1,5 +1,32 @@
 # starlight-dot-md
 
-A Starlight plugin that exposes raw markdown files at `.md` URLs.
+A Starlight plugin that serves your docs (.md, .mdx, .mdoc) as raw markdown for AI agents.
 
-For installation, usage, and configuration options, see the [documentation](https://starlight-dot-md.shf0811.workers.dev/).
+## Usage
+
+Install the package:
+
+```bash
+npm install starlight-dot-md@latest
+```
+
+Add the plugin to your Astro config:
+
+```js
+import starlight from "@astrojs/starlight";
+import { defineConfig } from "astro/config";
+import starlightDotMd from "starlight-dot-md";
+
+export default defineConfig({
+  integrations: [
+    starlight({
+      // ...
+      plugins: [starlightDotMd()],
+    }),
+  ],
+});
+```
+
+That's it! You can now access any page's source by appending `.md` to its URL (e.g., for a page at `/guides/example`, access `/guides/example.md`).
+
+For more details, see the [documentation](https://starlight-dot-md.shf0811.workers.dev/).

package/dist/index.d.mts

@@ -3,6 +3,7 @@ import { StarlightPlugin } from "@astrojs/starlight/types";
 //#region src/types.d.ts
 type StarlightDotMdOptions = {
   excludePatterns?: string[];
+  includeFrontmatter?: boolean;
   includePatterns?: string[];
   preserveExtension?: boolean;
 };

package/dist/index.mjs

@@ -1,6 +1,5 @@
 import { readdirSync, statSync } from "node:fs";
 import { join, relative } from "node:path";
-
 //#region src/index.ts
 function findFilesByExtension(dir, baseDir, extension) {
 	const results = [];
@@ -50,7 +49,7 @@ function starlightDotMd(options = {}) {
 		hooks: { setup({ addIntegration }) {
 			addIntegration({
 				name: "starlight-dot-md",
-				hooks: { "astro:config:setup": ({ injectRoute, updateConfig }) => {
+				hooks: { "astro:config:setup": ({ injectRoute, updateConfig, config }) => {
 					injectRoute({
 						pattern: "/[...slug].md",
 						entrypoint: "starlight-dot-md/slug.md",
@@ -69,15 +68,16 @@ function starlightDotMd(options = {}) {
 						});
 					}
 					updateConfig({ vite: { plugins: [vitePluginStarlightDotMdContext({
+						includeFrontmatter: options.includeFrontmatter ?? true,
 						excludePatterns: options.excludePatterns ?? [],
 						includePatterns: options.includePatterns ?? [],
-						preserveExtension: options.preserveExtension ?? false
+						preserveExtension: options.preserveExtension ?? false,
+						trailingSlash: config.trailingSlash ?? "ignore"
 					}, options.preserveExtension ?? false)] } });
 				} }
 			});
 		} }
 	};
 }
-
 //#endregion
-export { starlightDotMd as default };
+export { starlightDotMd as default };

package/dist/slug.md.mjs

@@ -1,7 +1,6 @@
-import { i as isMdx, n as isIncluded, r as isMdoc, t as isExcluded } from "./utils-BJKtrfbz.mjs";
+import { a as isMdx, i as isMdoc, n as isExcluded, o as originalSlugFromOutput, r as isIncluded, s as transformSlugForOutput, t as generateMarkdownContent } from "./utils-K4BnESpG.mjs";
 import { getCollection, getEntry } from "astro:content";
 import { context } from "virtual:starlight-dot-md/context";
-
 //#region src/slug.md.ts
 function shouldServe(slug) {
 	if (!isIncluded(slug) || isExcluded(slug)) return false;
@@ -9,18 +8,19 @@ function shouldServe(slug) {
 	return true;
 }
 const getStaticPaths = async () => {
-	return (await getCollection("docs")).filter((entry) => shouldServe(entry.id)).map((entry) => ({ params: { slug: entry.id } }));
+	return (await getCollection("docs")).filter((entry) => shouldServe(entry.id)).map((entry) => ({ params: { slug: transformSlugForOutput(entry.id) } }));
 };
 const GET = async ({ params }) => {
-	const slug = params.slug;
-	if (!slug || !shouldServe(slug)) return new Response("Not found", { status: 404 });
+	const outputSlug = params.slug;
+	if (!outputSlug) return new Response("Not found", { status: 404 });
+	const slug = originalSlugFromOutput(outputSlug);
+	if (!shouldServe(slug)) return new Response("Not found", { status: 404 });
 	const entry = await getEntry("docs", slug);
 	if (!entry) return new Response("Not found", { status: 404 });
-	return new Response(entry.body, {
+	return new Response(generateMarkdownContent(entry), {
 		status: 200,
 		headers: { "Content-Type": "text/markdown; charset=utf-8" }
 	});
 };
-
 //#endregion
-export { GET, getStaticPaths };
+export { GET, getStaticPaths };

package/dist/slug.mdoc.mjs

@@ -1,23 +1,23 @@
-import { n as isIncluded, r as isMdoc, t as isExcluded } from "./utils-BJKtrfbz.mjs";
+import { i as isMdoc, n as isExcluded, o as originalSlugFromOutput, r as isIncluded, s as transformSlugForOutput, t as generateMarkdownContent } from "./utils-K4BnESpG.mjs";
 import { getCollection, getEntry } from "astro:content";
-
 //#region src/slug.mdoc.ts
 function shouldServe(slug) {
 	return isMdoc(slug) && isIncluded(slug) && !isExcluded(slug);
 }
 const getStaticPaths = async () => {
-	return (await getCollection("docs")).filter((entry) => shouldServe(entry.id)).map((entry) => ({ params: { slug: entry.id } }));
+	return (await getCollection("docs")).filter((entry) => shouldServe(entry.id)).map((entry) => ({ params: { slug: transformSlugForOutput(entry.id) } }));
 };
 const GET = async ({ params }) => {
-	const slug = params.slug;
-	if (!slug || !shouldServe(slug)) return new Response("Not found", { status: 404 });
+	const outputSlug = params.slug;
+	if (!outputSlug) return new Response("Not found", { status: 404 });
+	const slug = originalSlugFromOutput(outputSlug);
+	if (!shouldServe(slug)) return new Response("Not found", { status: 404 });
 	const entry = await getEntry("docs", slug);
 	if (!entry) return new Response("Not found", { status: 404 });
-	return new Response(entry.body, {
+	return new Response(generateMarkdownContent(entry), {
 		status: 200,
 		headers: { "Content-Type": "text/markdown; charset=utf-8" }
 	});
 };
-
 //#endregion
-export { GET, getStaticPaths };
+export { GET, getStaticPaths };

package/dist/slug.mdx.mjs

@@ -1,23 +1,23 @@
-import { i as isMdx, n as isIncluded, t as isExcluded } from "./utils-BJKtrfbz.mjs";
+import { a as isMdx, n as isExcluded, o as originalSlugFromOutput, r as isIncluded, s as transformSlugForOutput, t as generateMarkdownContent } from "./utils-K4BnESpG.mjs";
 import { getCollection, getEntry } from "astro:content";
-
 //#region src/slug.mdx.ts
 function shouldServe(slug) {
 	return isMdx(slug) && isIncluded(slug) && !isExcluded(slug);
 }
 const getStaticPaths = async () => {
-	return (await getCollection("docs")).filter((entry) => shouldServe(entry.id)).map((entry) => ({ params: { slug: entry.id } }));
+	return (await getCollection("docs")).filter((entry) => shouldServe(entry.id)).map((entry) => ({ params: { slug: transformSlugForOutput(entry.id) } }));
 };
 const GET = async ({ params }) => {
-	const slug = params.slug;
-	if (!slug || !shouldServe(slug)) return new Response("Not found", { status: 404 });
+	const outputSlug = params.slug;
+	if (!outputSlug) return new Response("Not found", { status: 404 });
+	const slug = originalSlugFromOutput(outputSlug);
+	if (!shouldServe(slug)) return new Response("Not found", { status: 404 });
 	const entry = await getEntry("docs", slug);
 	if (!entry) return new Response("Not found", { status: 404 });
-	return new Response(entry.body, {
+	return new Response(generateMarkdownContent(entry), {
 		status: 200,
 		headers: { "Content-Type": "text/markdown; charset=utf-8" }
 	});
 };
-
 //#endregion
-export { GET, getStaticPaths };
+export { GET, getStaticPaths };

package/dist/utils-K4BnESpG.mjs

@@ -0,0 +1,33 @@
+import { context } from "virtual:starlight-dot-md/context";
+import { mdocSlugs, mdxSlugs } from "virtual:starlight-dot-md/files";
+import picomatch from "picomatch";
+import yaml from "yaml";
+//#region src/utils.ts
+function isMdx(slug) {
+	return mdxSlugs.has(slug);
+}
+function isMdoc(slug) {
+	return mdocSlugs.has(slug);
+}
+function isExcluded(slug) {
+	if (!context.excludePatterns || context.excludePatterns.length === 0) return false;
+	return picomatch.isMatch(slug, context.excludePatterns);
+}
+function isIncluded(slug) {
+	if (!context.includePatterns || context.includePatterns.length === 0) return true;
+	return picomatch.isMatch(slug, context.includePatterns);
+}
+function transformSlugForOutput(slug) {
+	if (context.trailingSlash === "always" && slug !== "index") return `${slug}/index`;
+	return slug;
+}
+function originalSlugFromOutput(outputSlug) {
+	if (context.trailingSlash === "always" && outputSlug !== "index" && outputSlug.endsWith("/index")) return outputSlug.slice(0, -6);
+	return outputSlug;
+}
+function generateMarkdownContent(entry) {
+	if (!context.includeFrontmatter) return entry.body ?? "";
+	return `---\n${yaml.stringify(entry.data)}---\n\n${entry.body ?? ""}`;
+}
+//#endregion
+export { isMdx as a, isMdoc as i, isExcluded as n, originalSlugFromOutput as o, isIncluded as r, transformSlugForOutput as s, generateMarkdownContent as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-dot-md",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "description": "A Starlight plugin that exposes raw markdown files at `.md` URLs.",
   "keywords": [
     "astro",
@@ -15,7 +15,7 @@
   "type": "module",
   "repository": {
     "type": "git",
-    "url": "https://github.com/morinokami/starlight-dot-md.git",
+    "url": "git+https://github.com/morinokami/starlight-dot-md.git",
     "directory": "packages/starlight-dot-md"
   },
   "bugs": {
@@ -34,20 +34,24 @@
     "dist"
   ],
   "dependencies": {
-    "picomatch": "4.0.3"
+    "picomatch": "4.0.4",
+    "yaml": "2.8.3"
   },
   "devDependencies": {
-    "@astrojs/starlight": "0.37.3",
-    "@types/node": "25.0.9",
-    "@types/picomatch": "4.0.2",
-    "astro": "5.16.11",
-    "tsdown": "0.18.3",
-    "typescript": "5.9.3"
+    "@astrojs/starlight": "0.38.3",
+    "@types/node": "25.6.0",
+    "@types/picomatch": "4.0.3",
+    "astro": "6.1.7",
+    "publint": "0.3.18",
+    "tsdown": "0.21.9",
+    "typescript": "6.0.3"
   },
   "peerDependencies": {
     "astro": ">=5.0.0"
   },
   "scripts": {
-    "build": "tsdown"
+    "build": "tsdown",
+    "lint": "biome ci",
+    "publint": "publint"
   }
 }

package/dist/utils-BJKtrfbz.mjs

@@ -1,22 +0,0 @@
-import { context } from "virtual:starlight-dot-md/context";
-import { mdocSlugs, mdxSlugs } from "virtual:starlight-dot-md/files";
-import picomatch from "picomatch";
-
-//#region src/utils.ts
-function isMdx(slug) {
-	return mdxSlugs.has(slug);
-}
-function isMdoc(slug) {
-	return mdocSlugs.has(slug);
-}
-function isExcluded(slug) {
-	if (!context.excludePatterns || context.excludePatterns.length === 0) return false;
-	return picomatch.isMatch(slug, context.excludePatterns);
-}
-function isIncluded(slug) {
-	if (!context.includePatterns || context.includePatterns.length === 0) return true;
-	return picomatch.isMatch(slug, context.includePatterns);
-}
-
-//#endregion
-export { isMdx as i, isIncluded as n, isMdoc as r, isExcluded as t };