starlight-dot-md 0.1.0

package/README.md

@@ -0,0 +1,74 @@
+# starlight-dot-md
+
+A Starlight integration 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`)

package/dist/index.d.mts

@@ -0,0 +1,13 @@
+import { AstroIntegration } from "astro";
+
+//#region src/types.d.ts
+type StarlightDotMdOptions = {
+  excludePatterns?: string[];
+  includePatterns?: string[];
+  preserveExtension?: boolean;
+};
+//#endregion
+//#region src/index.d.ts
+declare function starlightDotMd(options?: StarlightDotMdOptions): AstroIntegration;
+//#endregion
+export { starlightDotMd as default };

package/dist/index.mjs

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

package/dist/slug.md.d.mts

@@ -0,0 +1,7 @@
+import { APIRoute, GetStaticPaths } from "astro";
+
+//#region src/slug.md.d.ts
+declare const getStaticPaths: GetStaticPaths;
+declare const GET: APIRoute;
+//#endregion
+export { GET, getStaticPaths };

package/dist/slug.md.mjs

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

package/dist/slug.mdoc.d.mts

@@ -0,0 +1,7 @@
+import { APIRoute, GetStaticPaths } from "astro";
+
+//#region src/slug.mdoc.d.ts
+declare const getStaticPaths: GetStaticPaths;
+declare const GET: APIRoute;
+//#endregion
+export { GET, getStaticPaths };

package/dist/slug.mdoc.mjs

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

package/dist/slug.mdx.d.mts

@@ -0,0 +1,7 @@
+import { APIRoute, GetStaticPaths } from "astro";
+
+//#region src/slug.mdx.d.ts
+declare const getStaticPaths: GetStaticPaths;
+declare const GET: APIRoute;
+//#endregion
+export { GET, getStaticPaths };

package/dist/slug.mdx.mjs

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

package/dist/utils-DLGmXZ1G.mjs

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

package/package.json

@@ -0,0 +1,52 @@
+{
+	"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"
+	}
+}