starlight-dot-md 0.2.0 → 0.2.1

package/README.md

@@ -2,4 +2,31 @@
 
 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.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 = [];
@@ -80,6 +79,5 @@ function starlightDotMd(options = {}) {
 		} }
 	};
 }
-
 //#endregion
-export { starlightDotMd as default };
+export { starlightDotMd as default };

package/dist/slug.md.mjs

@@ -1,7 +1,6 @@
-import { a as isMdx, i as isMdoc, n as isExcluded, o as originalSlugFromOutput, r as isIncluded, s as transformSlugForOutput, t as generateMarkdownContent } from "./utils-C499GJ3Y.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;
@@ -23,6 +22,5 @@ const GET = async ({ params }) => {
 		headers: { "Content-Type": "text/markdown; charset=utf-8" }
 	});
 };
-
 //#endregion
-export { GET, getStaticPaths };
+export { GET, getStaticPaths };

package/dist/slug.mdoc.mjs

@@ -1,6 +1,5 @@
-import { i as isMdoc, n as isExcluded, o as originalSlugFromOutput, r as isIncluded, s as transformSlugForOutput, t as generateMarkdownContent } from "./utils-C499GJ3Y.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);
@@ -20,6 +19,5 @@ const GET = async ({ params }) => {
 		headers: { "Content-Type": "text/markdown; charset=utf-8" }
 	});
 };
-
 //#endregion
-export { GET, getStaticPaths };
+export { GET, getStaticPaths };

package/dist/slug.mdx.mjs

@@ -1,6 +1,5 @@
-import { a as isMdx, n as isExcluded, o as originalSlugFromOutput, r as isIncluded, s as transformSlugForOutput, t as generateMarkdownContent } from "./utils-C499GJ3Y.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);
@@ -20,6 +19,5 @@ const GET = async ({ params }) => {
 		headers: { "Content-Type": "text/markdown; charset=utf-8" }
 	});
 };
-
 //#endregion
-export { GET, getStaticPaths };
+export { GET, getStaticPaths };

package/dist/{utils-C499GJ3Y.mjs → utils-K4BnESpG.mjs}

@@ -2,7 +2,6 @@ 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);
@@ -30,6 +29,5 @@ 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 };
+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.2.0",
+  "version": "0.2.1",
   "description": "A Starlight plugin that exposes raw markdown files at `.md` URLs.",
   "keywords": [
     "astro",
@@ -34,17 +34,17 @@
     "dist"
   ],
   "dependencies": {
-    "picomatch": "4.0.3",
-    "yaml": "2.8.2"
+    "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",
-    "publint": "0.3.16",
-    "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"