starlight-dot-md 0.1.0 → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Shinya Fujino
+
+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/README.md

@@ -1,74 +1,5 @@
 # starlight-dot-md
 
-A Starlight integration that exposes raw markdown files at `.md` URLs.
+A Starlight plugin that exposes raw markdown files at `.md` URLs.
 
-## Installation
-
-```bash
-npm install starlight-dot-md
-```
-
-## Usage
-
-```js
-// astro.config.mjs
-import starlight from "@astrojs/starlight";
-import { defineConfig } from "astro/config";
-import starlightDotMd from "starlight-dot-md";
-
-export default defineConfig({
-  integrations: [
-    starlight({ ... }),
-    starlightDotMd(),
-  ],
-});
-```
-
-After build, access any page's source by appending `.md` to its URL (e.g., `/guides/example.md`).
-
-> **Note**: By default, both `.md` and `.mdx` files are served with the `.md` extension. Use the `preserveExtension` option to keep the original extension.
-
-## Options
-
-### `excludePatterns`
-
-An array of glob patterns to exclude pages from being served as `.md` files.
-
-```js
-starlightDotMd({
-  excludePatterns: ["private/**", "**/draft-*"],
-});
-```
-
-### `includePatterns`
-
-An array of glob patterns to include pages for being served as `.md` files. When specified, only pages matching these patterns will be served.
-
-```js
-starlightDotMd({
-  includePatterns: ["guides/**"],
-});
-```
-
-You can use both options together. Pages must match `includePatterns` (if specified) and not match `excludePatterns`.
-
-```js
-starlightDotMd({
-  includePatterns: ["guides/**"],
-  excludePatterns: ["guides/internal/**"],
-});
-```
-
-### `preserveExtension`
-
-When set to `true`, `.mdx` files are served with their original `.mdx` extension instead of being normalized to `.md`.
-
-```js
-starlightDotMd({
-  preserveExtension: true,
-});
-```
-
-With this option enabled:
-- `.md` files are served at `.md` URLs (e.g., `/guides/example.md`)
-- `.mdx` files are served at `.mdx` URLs (e.g., `/index.mdx`)
+For installation, usage, and configuration options, see the [documentation](https://starlight-dot-md.shf0811.workers.dev/).

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { AstroIntegration } from "astro";
+import { StarlightPlugin } from "@astrojs/starlight/types";
 
 //#region src/types.d.ts
 type StarlightDotMdOptions = {
@@ -8,6 +8,6 @@ type StarlightDotMdOptions = {
 };
 //#endregion
 //#region src/index.d.ts
-declare function starlightDotMd(options?: StarlightDotMdOptions): AstroIntegration;
+declare function starlightDotMd(options?: StarlightDotMdOptions): StarlightPlugin;
 //#endregion
 export { starlightDotMd as default };

package/dist/index.mjs

@@ -1,2 +1,83 @@
-import{readdirSync as e,statSync as t}from"node:fs";import{join as n,relative as r}from"node:path";function i(a,o,s){let c=[];try{let l=e(a);for(let e of l){let l=n(a,e);if(t(l).isDirectory())c.push(...i(l,o,s));else if(e.endsWith(s)){let e=r(o,l);c.push(e.replace(s,``))}}}catch{}return c}function a(e,t){let r=`virtual:starlight-dot-md/context`,a=`\0${r}`,o=`virtual:starlight-dot-md/files`,s=`\0${o}`,c=``;return{name:`vite-plugin-starlight-dot-md-context`,configResolved(e){c=e.root},resolveId(e){if(e===r)return a;if(e===o)return s},load(r){if(r===a)return`export const context = ${JSON.stringify(e)};`;if(r===s){if(!t)return`export const mdocSlugs = new Set();
-export const mdxSlugs = new Set();`;let e=n(c,`src/content/docs`),r=i(e,e,`.mdx`),a=i(e,e,`.mdoc`);return`export const mdocSlugs = new Set(${JSON.stringify(a)});\nexport const mdxSlugs = new Set(${JSON.stringify(r)});`}}}}function o(e={}){return{name:`starlight-dot-md`,hooks:{"astro:config:setup":({injectRoute:t,updateConfig:n})=>{t({pattern:`/[...slug].md`,entrypoint:`starlight-dot-md/slug.md`,prerender:!0}),e.preserveExtension&&(t({pattern:`/[...slug].mdx`,entrypoint:`starlight-dot-md/slug.mdx`,prerender:!0}),t({pattern:`/[...slug].mdoc`,entrypoint:`starlight-dot-md/slug.mdoc`,prerender:!0})),n({vite:{plugins:[a({excludePatterns:e.excludePatterns??[],includePatterns:e.includePatterns??[],preserveExtension:e.preserveExtension??!1},e.preserveExtension??!1)]}})}}}}export{o as default};
+import { readdirSync, statSync } from "node:fs";
+import { join, relative } from "node:path";
+
+//#region src/index.ts
+function findFilesByExtension(dir, baseDir, extension) {
+	const results = [];
+	try {
+		const entries = readdirSync(dir);
+		for (const entry of entries) {
+			const fullPath = join(dir, entry);
+			if (statSync(fullPath).isDirectory()) results.push(...findFilesByExtension(fullPath, baseDir, extension));
+			else if (entry.endsWith(extension)) {
+				const relativePath = relative(baseDir, fullPath);
+				results.push(relativePath.replace(extension, ""));
+			}
+		}
+	} catch {}
+	return results;
+}
+function vitePluginStarlightDotMdContext(context, preserveExtension) {
+	const contextModuleId = "virtual:starlight-dot-md/context";
+	const resolvedContextModuleId = `\0${contextModuleId}`;
+	const filesModuleId = "virtual:starlight-dot-md/files";
+	const resolvedFilesModuleId = `\0${filesModuleId}`;
+	let root = "";
+	return {
+		name: "vite-plugin-starlight-dot-md-context",
+		configResolved(config) {
+			root = config.root;
+		},
+		resolveId(id) {
+			if (id === contextModuleId) return resolvedContextModuleId;
+			if (id === filesModuleId) return resolvedFilesModuleId;
+		},
+		load(id) {
+			if (id === resolvedContextModuleId) return `export const context = ${JSON.stringify(context)};`;
+			if (id === resolvedFilesModuleId) {
+				if (!preserveExtension) return `export const mdocSlugs = new Set();\nexport const mdxSlugs = new Set();`;
+				const docsDir = join(root, "src/content/docs");
+				const mdxSlugs = findFilesByExtension(docsDir, docsDir, ".mdx");
+				const mdocSlugs = findFilesByExtension(docsDir, docsDir, ".mdoc");
+				return `export const mdocSlugs = new Set(${JSON.stringify(mdocSlugs)});\nexport const mdxSlugs = new Set(${JSON.stringify(mdxSlugs)});`;
+			}
+		}
+	};
+}
+function starlightDotMd(options = {}) {
+	return {
+		name: "starlight-dot-md",
+		hooks: { setup({ addIntegration }) {
+			addIntegration({
+				name: "starlight-dot-md",
+				hooks: { "astro:config:setup": ({ injectRoute, updateConfig }) => {
+					injectRoute({
+						pattern: "/[...slug].md",
+						entrypoint: "starlight-dot-md/slug.md",
+						prerender: true
+					});
+					if (options.preserveExtension) {
+						injectRoute({
+							pattern: "/[...slug].mdx",
+							entrypoint: "starlight-dot-md/slug.mdx",
+							prerender: true
+						});
+						injectRoute({
+							pattern: "/[...slug].mdoc",
+							entrypoint: "starlight-dot-md/slug.mdoc",
+							prerender: true
+						});
+					}
+					updateConfig({ vite: { plugins: [vitePluginStarlightDotMdContext({
+						excludePatterns: options.excludePatterns ?? [],
+						includePatterns: options.includePatterns ?? [],
+						preserveExtension: options.preserveExtension ?? false
+					}, options.preserveExtension ?? false)] } });
+				} }
+			});
+		} }
+	};
+}
+
+//#endregion
+export { starlightDotMd as default };

package/dist/slug.md.mjs

@@ -1 +1,26 @@
-import{i as e,n as t,r as n,t as r}from"./utils-DLGmXZ1G.mjs";import{getCollection as i,getEntry as a}from"astro:content";import{context as o}from"virtual:starlight-dot-md/context";function s(i){return!(!t(i)||r(i)||o.preserveExtension&&(e(i)||n(i)))}const c=async()=>(await i(`docs`)).filter(e=>s(e.id)).map(e=>({params:{slug:e.id}})),l=async({params:e})=>{let t=e.slug;if(!t||!s(t))return new Response(`Not found`,{status:404});let n=await a(`docs`,t);return n?new Response(n.body,{status:200,headers:{"Content-Type":`text/markdown; charset=utf-8`}}):new Response(`Not found`,{status:404})};export{l as GET,c as getStaticPaths};
+import { i as isMdx, n as isIncluded, r as isMdoc, t as isExcluded } from "./utils-BJKtrfbz.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;
+	if (context.preserveExtension && (isMdx(slug) || isMdoc(slug))) return false;
+	return true;
+}
+const getStaticPaths = async () => {
+	return (await getCollection("docs")).filter((entry) => shouldServe(entry.id)).map((entry) => ({ params: { slug: entry.id } }));
+};
+const GET = async ({ params }) => {
+	const slug = params.slug;
+	if (!slug || !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, {
+		status: 200,
+		headers: { "Content-Type": "text/markdown; charset=utf-8" }
+	});
+};
+
+//#endregion
+export { GET, getStaticPaths };

package/dist/slug.mdoc.mjs

@@ -1 +1,23 @@
-import{n as e,r as t,t as n}from"./utils-DLGmXZ1G.mjs";import{getCollection as r,getEntry as i}from"astro:content";function a(r){return t(r)&&e(r)&&!n(r)}const o=async()=>(await r(`docs`)).filter(e=>a(e.id)).map(e=>({params:{slug:e.id}})),s=async({params:e})=>{let t=e.slug;if(!t||!a(t))return new Response(`Not found`,{status:404});let n=await i(`docs`,t);return n?new Response(n.body,{status:200,headers:{"Content-Type":`text/markdown; charset=utf-8`}}):new Response(`Not found`,{status:404})};export{s as GET,o as getStaticPaths};
+import { n as isIncluded, r as isMdoc, t as isExcluded } from "./utils-BJKtrfbz.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 } }));
+};
+const GET = async ({ params }) => {
+	const slug = params.slug;
+	if (!slug || !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, {
+		status: 200,
+		headers: { "Content-Type": "text/markdown; charset=utf-8" }
+	});
+};
+
+//#endregion
+export { GET, getStaticPaths };

package/dist/slug.mdx.mjs

@@ -1 +1,23 @@
-import{i as e,n as t,t as n}from"./utils-DLGmXZ1G.mjs";import{getCollection as r,getEntry as i}from"astro:content";function a(r){return e(r)&&t(r)&&!n(r)}const o=async()=>(await r(`docs`)).filter(e=>a(e.id)).map(e=>({params:{slug:e.id}})),s=async({params:e})=>{let t=e.slug;if(!t||!a(t))return new Response(`Not found`,{status:404});let n=await i(`docs`,t);return n?new Response(n.body,{status:200,headers:{"Content-Type":`text/markdown; charset=utf-8`}}):new Response(`Not found`,{status:404})};export{s as GET,o as getStaticPaths};
+import { i as isMdx, n as isIncluded, t as isExcluded } from "./utils-BJKtrfbz.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 } }));
+};
+const GET = async ({ params }) => {
+	const slug = params.slug;
+	if (!slug || !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, {
+		status: 200,
+		headers: { "Content-Type": "text/markdown; charset=utf-8" }
+	});
+};
+
+//#endregion
+export { GET, getStaticPaths };

package/dist/utils-BJKtrfbz.mjs

@@ -0,0 +1,22 @@
+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 };

package/package.json

@@ -1,52 +1,53 @@
 {
-	"name": "starlight-dot-md",
-	"version": "0.1.0",
-	"description": "A Starlight integration that exposes raw markdown files at `.md` URLs.",
-	"keywords": [
-		"astro",
-		"withastro",
-		"astro-component",
-		"astro-integration",
-		"starlight",
-		"ai"
-	],
-	"author": "Shinya Fujino <shf0811@gmail.com> (https://github.com/morinokami)",
-	"license": "MIT",
-	"type": "module",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/morinokami/starlight-dot-md.git",
-		"directory": "packages/starlight-dot-md"
-	},
-	"bugs": {
-		"url": "https://github.com/morinokami/starlight-dot-md/issues"
-	},
-	"exports": {
-		".": "./dist/index.mjs",
-		"./slug.md": "./dist/slug.md.mjs",
-		"./slug.mdx": "./dist/slug.mdx.mjs",
-		"./slug.mdoc": "./dist/slug.mdoc.mjs"
-	},
-	"main": "./dist/index.mjs",
-	"module": "./dist/index.mjs",
-	"types": "./dist/index.d.mts",
-	"files": [
-		"dist"
-	],
-	"scripts": {
-		"build": "tsdown",
-		"typecheck": "tsc --noEmit"
-	},
-	"dependencies": {
-		"picomatch": "catalog:"
-	},
-	"devDependencies": {
-		"@types/picomatch": "catalog:",
-		"astro": "catalog:",
-		"tsdown": "catalog:",
-		"typescript": "catalog:"
-	},
-	"peerDependencies": {
-		"astro": ">=5.0.0"
-	}
-}
+  "name": "starlight-dot-md",
+  "version": "0.1.2",
+  "description": "A Starlight plugin that exposes raw markdown files at `.md` URLs.",
+  "keywords": [
+    "astro",
+    "withastro",
+    "astro-component",
+    "astro-integration",
+    "starlight",
+    "ai"
+  ],
+  "author": "Shinya Fujino <shf0811@gmail.com> (https://github.com/morinokami)",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/morinokami/starlight-dot-md.git",
+    "directory": "packages/starlight-dot-md"
+  },
+  "bugs": {
+    "url": "https://github.com/morinokami/starlight-dot-md/issues"
+  },
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./slug.md": "./dist/slug.md.mjs",
+    "./slug.mdx": "./dist/slug.mdx.mjs",
+    "./slug.mdoc": "./dist/slug.mdoc.mjs"
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "picomatch": "4.0.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"
+  },
+  "peerDependencies": {
+    "astro": ">=5.0.0"
+  },
+  "scripts": {
+    "build": "tsdown"
+  }
+}

package/dist/utils-DLGmXZ1G.mjs

@@ -1 +0,0 @@
-import{context as e}from"virtual:starlight-dot-md/context";import{mdocSlugs as t,mdxSlugs as n}from"virtual:starlight-dot-md/files";import r from"picomatch";function i(e){return n.has(e)}function a(e){return t.has(e)}function o(t){return!e.excludePatterns||e.excludePatterns.length===0?!1:r.isMatch(t,e.excludePatterns)}function s(t){return!e.includePatterns||e.includePatterns.length===0?!0:r.isMatch(t,e.includePatterns)}export{i,s as n,a as r,o as t};