docstra 0.1.0 → 1.0.1

package/dist/server/index.d.mts

@@ -0,0 +1,51 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+interface DocstraConfig {
+    siteName?: string;
+    editOnGithub?: boolean;
+    formSyncFormID?: string;
+    githubRepo?: string;
+    navbar?: {
+        logo?: {
+            link: string;
+            src: string;
+            alt: string;
+            className?: string;
+        };
+        links?: {
+            name: string;
+            href: string;
+        }[];
+    };
+    sidebar?: {
+        links?: DocsLinkGroup[];
+    };
+}
+interface DocsLinkItem {
+    name: string;
+    href: string;
+    icon?: string;
+}
+interface DocsLinkGroup {
+    section: string;
+    items: DocsLinkItem[];
+}
+type Slug = string | string[] | undefined;
+interface FileContent {
+    metadata: Record<string, any>;
+    mdxContent: string;
+    rawMdxContent: string;
+    mdxFilePath: string;
+}
+
+declare function getFilePath(slug: Slug): string;
+declare function getFileContents(slug: Slug): FileContent;
+
+declare function defineDocstraConfig(config: DocstraConfig): DocstraConfig;
+
+declare function DocstraMDXCompiler({ mdxContent, components }: {
+    mdxContent: string;
+    components?: Record<string, any>;
+}): react_jsx_runtime.JSX.Element;
+
+export { DocstraMDXCompiler, defineDocstraConfig, getFileContents, getFilePath };

package/dist/server/index.d.ts

@@ -0,0 +1,51 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+interface DocstraConfig {
+    siteName?: string;
+    editOnGithub?: boolean;
+    formSyncFormID?: string;
+    githubRepo?: string;
+    navbar?: {
+        logo?: {
+            link: string;
+            src: string;
+            alt: string;
+            className?: string;
+        };
+        links?: {
+            name: string;
+            href: string;
+        }[];
+    };
+    sidebar?: {
+        links?: DocsLinkGroup[];
+    };
+}
+interface DocsLinkItem {
+    name: string;
+    href: string;
+    icon?: string;
+}
+interface DocsLinkGroup {
+    section: string;
+    items: DocsLinkItem[];
+}
+type Slug = string | string[] | undefined;
+interface FileContent {
+    metadata: Record<string, any>;
+    mdxContent: string;
+    rawMdxContent: string;
+    mdxFilePath: string;
+}
+
+declare function getFilePath(slug: Slug): string;
+declare function getFileContents(slug: Slug): FileContent;
+
+declare function defineDocstraConfig(config: DocstraConfig): DocstraConfig;
+
+declare function DocstraMDXCompiler({ mdxContent, components }: {
+    mdxContent: string;
+    components?: Record<string, any>;
+}): react_jsx_runtime.JSX.Element;
+
+export { DocstraMDXCompiler, defineDocstraConfig, getFileContents, getFilePath };

package/dist/server/index.js

@@ -0,0 +1,176 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/server/index.ts
+var server_exports = {};
+__export(server_exports, {
+  DocstraMDXCompiler: () => DocstraMDXCompiler,
+  defineDocstraConfig: () => defineDocstraConfig,
+  getFileContents: () => getFileContents,
+  getFilePath: () => getFilePath
+});
+module.exports = __toCommonJS(server_exports);
+
+// src/server/get-mdx-content.ts
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_gray_matter = __toESM(require("gray-matter"));
+var CONTENT_DIR = import_path.default.join(process.cwd(), "app", "docs", "content");
+function getFilePath(slug) {
+  const slugArray = Array.isArray(slug) && slug.length > 0 ? slug : ["index"];
+  const possiblePaths = [
+    import_path.default.join(CONTENT_DIR, ...slugArray) + ".mdx",
+    import_path.default.join(CONTENT_DIR, ...slugArray) + ".md",
+    import_path.default.join(CONTENT_DIR, ...slugArray, "index.mdx"),
+    import_path.default.join(CONTENT_DIR, ...slugArray, "index.md")
+  ];
+  for (const filePath of possiblePaths) {
+    if (import_fs.default.existsSync(filePath)) {
+      return filePath;
+    }
+  }
+  throw new Error(`\u274C MDX file not found for slug: ${slugArray.join("/")} `);
+}
+function getFileContents(slug) {
+  const filePath = getFilePath(slug);
+  const rawFile = import_fs.default.readFileSync(filePath, "utf-8");
+  const { data, content } = (0, import_gray_matter.default)(rawFile);
+  return {
+    metadata: data,
+    mdxContent: content,
+    rawMdxContent: rawFile,
+    mdxFilePath: filePath
+  };
+}
+
+// src/server/docstra-config.ts
+function defineDocstraConfig(config) {
+  return config;
+}
+
+// src/server/mdx-compiler.tsx
+var import_rsc = require("next-mdx-remote/rsc");
+
+// src/client/mdx-components.tsx
+var import_link = __toESM(require("next/link"));
+
+// src/client/create-heading.tsx
+var import_lucide_react = require("lucide-react");
+
+// src/utils/generate-id-from-text.ts
+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_runtime = require("react/jsx-runtime");
+function CreateHeading({ children, level }) {
+  const Heading = `h${level}`;
+  const text = typeof children === "string" ? children : "";
+  const id = generateIdFromText(text);
+  let fontSize;
+  let iconSize;
+  switch (level) {
+    case 1:
+      fontSize = "text-3xl";
+      break;
+    case 2:
+      fontSize = "text-2xl";
+      iconSize = "size-5";
+      break;
+    case 3:
+      fontSize = "text-xl";
+      iconSize = "size-4.5";
+      break;
+    case 4:
+      fontSize = "text-lg";
+      iconSize = "size-4.5";
+      break;
+    case 5:
+      fontSize = "text-base";
+      iconSize = "size-3.5";
+      break;
+    default:
+      fontSize = "text-base";
+      iconSize = "size-3.5";
+  }
+  return level === 1 ? /* @__PURE__ */ (0, import_jsx_runtime.jsx)("h1", { className: "text-3xl font-bold text-gray-900 mb-4", children }) : /* @__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_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` })
+      ]
+    }
+  );
+}
+
+// src/client/mdx-components.tsx
+var import_jsx_runtime2 = require("react/jsx-runtime");
+var defaultMdxComponents = {
+  h1: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(CreateHeading, { ...props, level: 1 }),
+  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 }),
+  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) => props.href.startsWith("/") ? /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(import_link.default, { className: "underline underline-offset-4", href: props.href, children: props.children }) : /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("a", { className: "underline underline-offset-4", href: props.href, 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/mdx-compiler.tsx
+var import_jsx_runtime3 = require("react/jsx-runtime");
+function DocstraMDXCompiler({
+  mdxContent,
+  components = {}
+}) {
+  return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(import_jsx_runtime3.Fragment, { children: /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(
+    import_rsc.MDXRemote,
+    {
+      source: mdxContent,
+      components: {
+        ...defaultMdxComponents,
+        ...components
+      }
+    }
+  ) });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DocstraMDXCompiler,
+  defineDocstraConfig,
+  getFileContents,
+  getFilePath
+});

package/dist/server/index.mjs

@@ -0,0 +1,136 @@
+// src/server/get-mdx-content.ts
+import fs from "fs";
+import path from "path";
+import matter from "gray-matter";
+var CONTENT_DIR = path.join(process.cwd(), "app", "docs", "content");
+function getFilePath(slug) {
+  const slugArray = Array.isArray(slug) && slug.length > 0 ? slug : ["index"];
+  const possiblePaths = [
+    path.join(CONTENT_DIR, ...slugArray) + ".mdx",
+    path.join(CONTENT_DIR, ...slugArray) + ".md",
+    path.join(CONTENT_DIR, ...slugArray, "index.mdx"),
+    path.join(CONTENT_DIR, ...slugArray, "index.md")
+  ];
+  for (const filePath of possiblePaths) {
+    if (fs.existsSync(filePath)) {
+      return filePath;
+    }
+  }
+  throw new Error(`\u274C MDX file not found for slug: ${slugArray.join("/")} `);
+}
+function getFileContents(slug) {
+  const filePath = getFilePath(slug);
+  const rawFile = fs.readFileSync(filePath, "utf-8");
+  const { data, content } = matter(rawFile);
+  return {
+    metadata: data,
+    mdxContent: content,
+    rawMdxContent: rawFile,
+    mdxFilePath: filePath
+  };
+}
+
+// src/server/docstra-config.ts
+function defineDocstraConfig(config) {
+  return config;
+}
+
+// src/server/mdx-compiler.tsx
+import { MDXRemote } from "next-mdx-remote/rsc";
+
+// src/client/mdx-components.tsx
+import Link from "next/link";
+
+// src/client/create-heading.tsx
+import { LinkIcon } from "lucide-react";
+
+// src/utils/generate-id-from-text.ts
+function generateIdFromText(text) {
+  return text.toLowerCase().trim().replace(/[^\w\s-]/g, "").replace(/\s+/g, "-").replace(/-+/g, "-").replace(/^-|-$/g, "");
+}
+
+// src/client/create-heading.tsx
+import { jsx, jsxs } from "react/jsx-runtime";
+function CreateHeading({ children, level }) {
+  const Heading = `h${level}`;
+  const text = typeof children === "string" ? children : "";
+  const id = generateIdFromText(text);
+  let fontSize;
+  let iconSize;
+  switch (level) {
+    case 1:
+      fontSize = "text-3xl";
+      break;
+    case 2:
+      fontSize = "text-2xl";
+      iconSize = "size-5";
+      break;
+    case 3:
+      fontSize = "text-xl";
+      iconSize = "size-4.5";
+      break;
+    case 4:
+      fontSize = "text-lg";
+      iconSize = "size-4.5";
+      break;
+    case 5:
+      fontSize = "text-base";
+      iconSize = "size-3.5";
+      break;
+    default:
+      fontSize = "text-base";
+      iconSize = "size-3.5";
+  }
+  return level === 1 ? /* @__PURE__ */ jsx("h1", { className: "text-3xl font-bold text-gray-900 mb-4", children }) : /* @__PURE__ */ 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__ */ jsx("a", { href: `#${id}`, children }),
+        /* @__PURE__ */ jsx(LinkIcon, { className: `${iconSize} text-gray-400 opacity-0 group-hover:opacity-100 transition` })
+      ]
+    }
+  );
+}
+
+// src/client/mdx-components.tsx
+import { jsx as jsx2 } from "react/jsx-runtime";
+var defaultMdxComponents = {
+  h1: (props) => /* @__PURE__ */ jsx2(CreateHeading, { ...props, level: 1 }),
+  h2: (props) => /* @__PURE__ */ jsx2(CreateHeading, { ...props, level: 2 }),
+  h3: (props) => /* @__PURE__ */ jsx2(CreateHeading, { ...props, level: 3 }),
+  h4: (props) => /* @__PURE__ */ jsx2(CreateHeading, { ...props, level: 4 }),
+  h5: (props) => /* @__PURE__ */ jsx2(CreateHeading, { ...props, level: 5 }),
+  p: (props) => /* @__PURE__ */ jsx2("p", { className: "my-5", children: props.children }),
+  hr: () => /* @__PURE__ */ jsx2("hr", { className: "my-10 border-gray-200" }),
+  a: (props) => props.href.startsWith("/") ? /* @__PURE__ */ jsx2(Link, { className: "underline underline-offset-4", href: props.href, children: props.children }) : /* @__PURE__ */ jsx2("a", { className: "underline underline-offset-4", href: props.href, children: props.children }),
+  ul: (props) => /* @__PURE__ */ jsx2("ul", { className: "list-['-'] pl-4 space-y-2", children: props.children }),
+  li: (props) => /* @__PURE__ */ jsx2("li", { className: "mb-2 pl-3 text-gray-700", children: props.children }),
+  ol: (props) => /* @__PURE__ */ jsx2("ol", { className: "list-decimal pl-4 space-y-2", children: props.children }),
+  blockquote: (props) => /* @__PURE__ */ jsx2("blockquote", { className: "border-l-4 border-gray-200 pl-4 my-8 text-gray-700", children: props.children })
+};
+
+// src/server/mdx-compiler.tsx
+import { Fragment, jsx as jsx3 } from "react/jsx-runtime";
+function DocstraMDXCompiler({
+  mdxContent,
+  components = {}
+}) {
+  return /* @__PURE__ */ jsx3(Fragment, { children: /* @__PURE__ */ jsx3(
+    MDXRemote,
+    {
+      source: mdxContent,
+      components: {
+        ...defaultMdxComponents,
+        ...components
+      }
+    }
+  ) });
+}
+export {
+  DocstraMDXCompiler,
+  defineDocstraConfig,
+  getFileContents,
+  getFilePath
+};