docstra 1.6.3 → 1.7.0

package/dist/server/index.d.mts

@@ -1,11 +1,9 @@
-import { D as DocstraConfig, b as DocstraMdxCompilerProps } from '../types-BCr1htTq.mjs';
-import * as react_jsx_runtime from 'react/jsx-runtime';
+import { D as DocstraConfig, p as pageDataContent, g as getSitemapProps } from '../types-QzxGYJU4.mjs';
 import { NextConfig } from 'next';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 
 declare function defineDocstraConfig<T extends DocstraConfig>(config: T): T;
 
-declare function DocstraMDXCompiler({ content, components }: DocstraMdxCompilerProps): react_jsx_runtime.JSX.Element;
-
 declare function withDocstra<T extends NextConfig>(nextConfig?: T): T;
 
 declare function defaultMdxComponents(): {
@@ -26,4 +24,21 @@ declare function defaultMdxComponents(): {
 
 declare function getPageData(slug: string[], docs: any[]): any;
 
-export { DocstraMDXCompiler, defaultMdxComponents, defineDocstraConfig, getPageData, withDocstra };
+declare function createSource(docs: any[]): {
+    getPage: (slug: string[] | undefined) => {
+        info: any;
+        body: any;
+    } | null;
+    generateStaticParams: () => {
+        slug: any;
+    }[];
+    files: pageDataContent[];
+    generateSitemap: ({ baseUrl, lastmod, changefreq, priority }: getSitemapProps) => {
+        url: string;
+        lastModified: string | undefined;
+        changeFrequency: any;
+        priority: number | undefined;
+    }[];
+};
+
+export { createSource, defaultMdxComponents, defineDocstraConfig, getPageData, withDocstra };

package/dist/server/index.d.ts

@@ -1,11 +1,9 @@
-import { D as DocstraConfig, b as DocstraMdxCompilerProps } from '../types-BCr1htTq.js';
-import * as react_jsx_runtime from 'react/jsx-runtime';
+import { D as DocstraConfig, p as pageDataContent, g as getSitemapProps } from '../types-QzxGYJU4.js';
 import { NextConfig } from 'next';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 
 declare function defineDocstraConfig<T extends DocstraConfig>(config: T): T;
 
-declare function DocstraMDXCompiler({ content, components }: DocstraMdxCompilerProps): react_jsx_runtime.JSX.Element;
-
 declare function withDocstra<T extends NextConfig>(nextConfig?: T): T;
 
 declare function defaultMdxComponents(): {
@@ -26,4 +24,21 @@ declare function defaultMdxComponents(): {
 
 declare function getPageData(slug: string[], docs: any[]): any;
 
-export { DocstraMDXCompiler, defaultMdxComponents, defineDocstraConfig, getPageData, withDocstra };
+declare function createSource(docs: any[]): {
+    getPage: (slug: string[] | undefined) => {
+        info: any;
+        body: any;
+    } | null;
+    generateStaticParams: () => {
+        slug: any;
+    }[];
+    files: pageDataContent[];
+    generateSitemap: ({ baseUrl, lastmod, changefreq, priority }: getSitemapProps) => {
+        url: string;
+        lastModified: string | undefined;
+        changeFrequency: any;
+        priority: number | undefined;
+    }[];
+};
+
+export { createSource, defaultMdxComponents, defineDocstraConfig, getPageData, withDocstra };

package/dist/server/index.js

@@ -1749,7 +1749,7 @@ var init_esm2 = __esm({
 // src/server/index.ts
 var server_exports = {};
 __export(server_exports, {
-  DocstraMDXCompiler: () => DocstraMDXCompiler,
+  createSource: () => createSource,
   defaultMdxComponents: () => defaultMdxComponents,
   defineDocstraConfig: () => defineDocstraConfig,
   getPageData: () => getPageData,
@@ -1762,54 +1762,9 @@ function defineDocstraConfig(config) {
   return config;
 }
 
-// src/server/mdx-compiler.tsx
-var import_rsc = require("next-mdx-remote/rsc");
-
-// src/plugins/rehype-code-meta.ts
-var import_unist_util_visit = require("unist-util-visit");
-function rehypeCodeMetaProps() {
-  return (tree) => {
-    (0, import_unist_util_visit.visit)(tree, "element", (node) => {
-      if (node.tagName !== "pre") return;
-      const code = node.children?.[0];
-      if (!code || code.tagName !== "code") return;
-      const className = code.properties?.className?.[0];
-      const language = className?.replace("language-", "");
-      const meta = code.data?.meta || "";
-      const metaProps = {};
-      meta.replace(
-        /(\w+)=["']?([^"'\s]+)["']?/g,
-        (_match, key, value) => {
-          metaProps[key] = value;
-          return "";
-        }
-      );
-      node.properties = { ...node.properties || {}, language, ...metaProps };
-    });
-  };
-}
-
-// src/server/mdx-compiler.tsx
-var import_jsx_runtime = require("react/jsx-runtime");
-function DocstraMDXCompiler({ content, components = {} }) {
-  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(
-    import_rsc.MDXRemote,
-    {
-      source: content,
-      components,
-      options: {
-        mdxOptions: {
-          rehypePlugins: [rehypeCodeMetaProps]
-        }
-      }
-    }
-  );
-}
-
 // src/server/build.ts
 var import_fs = __toESM(require("fs"));
 var import_path = __toESM(require("path"));
-var import_gray_matter = __toESM(require("gray-matter"));
 function runDocstraBuild(contentDir) {
   const root = process.cwd();
   const outDir = import_path.default.join(root, ".docstra");
@@ -1817,28 +1772,30 @@ function runDocstraBuild(contentDir) {
   if (!import_fs.default.existsSync(contentDir)) return;
   if (!import_fs.default.existsSync(outDir)) import_fs.default.mkdirSync(outDir, { recursive: true });
   const files = getAllMdxFiles(contentDir);
-  const exportEntries = [];
-  files.forEach((file) => {
-    const raw = import_fs.default.readFileSync(file, "utf8");
-    const { data: frontmatter, content } = (0, import_gray_matter.default)(raw);
+  const imports = [];
+  const docEntries = [];
+  files.forEach((file, index) => {
+    const relPath = import_path.default.relative(outDir, file).replace(/\\/g, "/");
+    const importName = `d${index}`;
+    imports.push(`import * as ${importName} from "${relPath}?docstra";`);
     const relFromContent = import_path.default.relative(contentDir, file).replace(/\\/g, "/");
     const slug = resolveSlugFromFile(relFromContent);
-    exportEntries.push(`{
-  info: {
+    docEntries.push(`{
+    slug: "${slug}",
     path: "${relFromContent}",
-    fullPath: "${contentDir}/${relFromContent}",
-    slug: "${slug}"
-  },
-  headings: ${JSON.stringify(extractHeadings(content))},
-  frontmatter: ${JSON.stringify(frontmatter, null, 2)},
-  content: ${JSON.stringify(content)},
-  rawContent: ${JSON.stringify(raw)}
-}`);
+    data: {
+        metadata: ${importName}.metadata,
+        raw: ${importName}.raw,
+        tableOfContents: ${importName}.tableOfContents,
+        mdxContent: ${importName}.mdxContent
+    }
+  }`);
   });
   const finalOutput = `// @ts-nocheck -- auto generated by docstra
+${imports.join("\n")}
 
 export const docs = [
-${exportEntries.join(",\n")}
+  ${docEntries.join(",\n  ")}
 ];
 `;
   import_fs.default.writeFileSync(outFile, finalOutput, "utf8");
@@ -1859,9 +1816,6 @@ function getAllMdxFiles(dir) {
 function resolveSlugFromFile(relFromContent) {
   return relFromContent.replace(/\\/g, "/").replace(/\/index\.(md|mdx)$/, "").replace(/\.(md|mdx)$/, "");
 }
-function extractHeadings(content) {
-  return content.split("\n").filter((line) => line.startsWith("#")).map((h) => h.replace(/#/g, "").trim());
-}
 
 // src/server/dev.ts
 var watcherStarted = false;
@@ -1939,11 +1893,26 @@ function withDocstra(nextConfig = {}) {
   }
   return {
     ...nextConfig,
-    pageExtensions: nextConfig.pageExtensions ?? ["ts", "tsx", "js", "jsx", "md", "mdx"]
+    pageExtensions: nextConfig.pageExtensions ?? ["ts", "tsx", "js", "jsx", "md", "mdx"],
+    webpack: (config, options) => {
+      config.module.rules.push({
+        test: /\.(md|mdx)$/,
+        resourceQuery: /docstra/,
+        use: [
+          {
+            loader: require.resolve("./docstra-loader")
+          }
+        ]
+      });
+      if (typeof nextConfig.webpack === "function") {
+        return nextConfig.webpack(config, options);
+      }
+      return config;
+    }
   };
 }
 
-// src/client/create-heading.tsx
+// src/client/components/create-heading.tsx
 var import_lucide_react = require("lucide-react");
 
 // src/utils/generate-id-from-text.ts
@@ -1951,8 +1920,8 @@ function generateIdFromText(text) {
   return text.toLowerCase().trim().replace(/[^\w\s-]/g, "").replace(/\s+/g, "-").replace(/-+/g, "-").replace(/^-|-$/g, "");
 }
 
-// src/client/create-heading.tsx
-var import_jsx_runtime2 = require("react/jsx-runtime");
+// src/client/components/create-heading.tsx
+var import_jsx_runtime = require("react/jsx-runtime");
 function CreateHeading({ children, level }) {
   const Heading = `h${level}`;
   const text = typeof children === "string" ? children : "";
@@ -1980,14 +1949,14 @@ function CreateHeading({ children, level }) {
       fontSize = "text-base";
       iconSize = "size-3.5";
   }
-  return /* @__PURE__ */ (0, import_jsx_runtime2.jsxs)(
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(
     Heading,
     {
       id,
       className: `group mt-10 gap-2 mb-4 flex items-center scroll-mt-26 ${fontSize} font-semibold text-gray-900`,
       children: [
-        /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("a", { href: `#${id}`, children }),
-        /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(import_lucide_react.LinkIcon, { className: `${iconSize} text-gray-400 opacity-0 group-hover:opacity-100 transition` })
+        /* @__PURE__ */ (0, import_jsx_runtime.jsx)("a", { href: `#${id}`, children }),
+        /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_lucide_react.LinkIcon, { className: `${iconSize} text-gray-400 opacity-0 group-hover:opacity-100 transition` })
       ]
     }
   );
@@ -1995,38 +1964,91 @@ function CreateHeading({ children, level }) {
 
 // src/server/mdx-components.tsx
 var import_link = __toESM(require("next/link"));
-var import_jsx_runtime3 = require("react/jsx-runtime");
+var import_jsx_runtime2 = require("react/jsx-runtime");
 function defaultMdxComponents() {
   return {
-    h1: (props) => /* @__PURE__ */ (0, import_jsx_runtime3.jsx)("h1", { className: "text-3xl font-bold text-gray-900 mb-4", children: props.children }),
-    h2: (props) => /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(CreateHeading, { ...props, level: 2 }),
-    h3: (props) => /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(CreateHeading, { ...props, level: 3 }),
-    h4: (props) => /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(CreateHeading, { ...props, level: 4 }),
-    h5: (props) => /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(CreateHeading, { ...props, level: 5 }),
-    code: (props) => /* @__PURE__ */ (0, import_jsx_runtime3.jsx)("code", { className: "px-1 py-0.5 rounded border border-gray-200 text-gray-800 text-sm", children: props.children }),
-    p: (props) => /* @__PURE__ */ (0, import_jsx_runtime3.jsx)("p", { className: "my-5", children: props.children }),
-    hr: () => /* @__PURE__ */ (0, import_jsx_runtime3.jsx)("hr", { className: "my-10 border-gray-200" }),
+    h1: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("h1", { className: "text-3xl font-bold text-gray-900 mb-4", children: props.children }),
+    h2: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(CreateHeading, { ...props, level: 2 }),
+    h3: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(CreateHeading, { ...props, level: 3 }),
+    h4: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(CreateHeading, { ...props, level: 4 }),
+    h5: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(CreateHeading, { ...props, level: 5 }),
+    code: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("code", { className: "px-1 py-0.5 rounded border border-gray-200 text-gray-800 text-sm", children: props.children }),
+    p: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("p", { className: "my-5", children: props.children }),
+    hr: () => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("hr", { className: "my-10 border-gray-200" }),
     a: (props) => {
       if (props.href.startsWith("http")) {
-        return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)("a", { href: props.href, className: "underline underline-offset-4", ...props, target: "_blank", rel: "noopener noreferrer", children: props.children });
+        return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("a", { href: props.href, className: "underline underline-offset-4", ...props, target: "_blank", rel: "noopener noreferrer", children: props.children });
       }
-      return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(import_link.default, { href: props.href, className: "underline underline-offset-4", ...props, children: props.children });
+      return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(import_link.default, { href: props.href, className: "underline underline-offset-4", ...props, children: props.children });
     },
-    ul: (props) => /* @__PURE__ */ (0, import_jsx_runtime3.jsx)("ul", { className: "list-['-'] pl-4 space-y-2", children: props.children }),
-    li: (props) => /* @__PURE__ */ (0, import_jsx_runtime3.jsx)("li", { className: "mb-2 pl-3 text-gray-700", children: props.children }),
-    ol: (props) => /* @__PURE__ */ (0, import_jsx_runtime3.jsx)("ol", { className: "list-decimal pl-4 space-y-2", children: props.children }),
-    blockquote: (props) => /* @__PURE__ */ (0, import_jsx_runtime3.jsx)("blockquote", { className: "border-l-4 border-gray-200 pl-4 my-8 text-gray-700", children: props.children })
+    ul: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("ul", { className: "list-['-'] pl-4 space-y-2", children: props.children }),
+    li: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("li", { className: "mb-2 pl-3 text-gray-700", children: props.children }),
+    ol: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("ol", { className: "list-decimal pl-4 space-y-2", children: props.children }),
+    blockquote: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("blockquote", { className: "border-l-4 border-gray-200 pl-4 my-8 text-gray-700", children: props.children })
   };
 }
 
 // src/server/get-page-data.ts
 function getPageData(slug, docs) {
-  const pageData = docs.find((d) => d.info.slug === (slug?.join("/") || "index"));
+  const pageData = docs.find((d) => d.slug === (slug?.join("/") || "index"));
   return pageData;
 }
+
+// src/server/source.ts
+function createSource(docs) {
+  return {
+    getPage: (slug) => {
+      const slugStr = slug?.join("/") || "index";
+      const doc = docs.find((d) => d.slug === slugStr);
+      if (!doc) return null;
+      const { mdxContent, ...safeData } = doc.data;
+      return {
+        info: {
+          ...doc,
+          data: safeData
+        },
+        body: doc.data.mdxContent
+      };
+    },
+    generateStaticParams: () => {
+      return docs.map((d) => ({
+        slug: d.slug === "index" ? [] : d.slug.split("/")
+      }));
+    },
+    // Returns generic metadata for all pages (stripped of MDX component)
+    // Useful for Sidebar, Search, global context
+    files: docs.map((d) => {
+      const { mdxContent, ...safeData } = d.data;
+      return {
+        ...d,
+        data: safeData
+      };
+    }),
+    // Returns user to sitemap with 
+    // <url>
+    //     <loc>https://example.com/page</loc>
+    //     <lastmod>2022-01-01</lastmod>
+    //     <changefreq>monthly</changefreq>
+    //     <priority>0.5</priority>
+    // </url>
+    generateSitemap: ({
+      baseUrl,
+      lastmod,
+      changefreq,
+      priority
+    }) => {
+      return docs.map((d) => ({
+        url: `${baseUrl}/${d.slug.replace("index", "")}`,
+        lastModified: lastmod,
+        changeFrequency: changefreq,
+        priority
+      }));
+    }
+  };
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  DocstraMDXCompiler,
+  createSource,
   defaultMdxComponents,
   defineDocstraConfig,
   getPageData,