docstra 1.3.0 → 1.4.0

package/dist/client/index.d.mts

@@ -7,10 +7,22 @@ interface DocstraContextType {
     docstraConfig: DocstraConfig;
     openSearchBox: boolean;
     setOpenSearchBox: (open: boolean) => void;
+    mdxData: mdxDataContent;
+}
+interface mdxDataContent {
+    metadata: Record<string, any>;
+    mdxContent: string;
+    rawMdxContent: string;
+    mdxFilePath: string;
 }
 interface DocstraConfig {
     siteName?: string;
     editOnGithub?: boolean;
+    feedback?: {
+        enabled?: boolean;
+        formSyncFormID?: string;
+        watermark?: boolean;
+    };
     formSyncFormID?: string;
     githubRepo?: string;
     navbar?: {
@@ -39,9 +51,10 @@ interface DocsLinkGroup {
     items: DocsLinkItem[];
 }
 
-declare function DocstraProvider({ children, docstraConfig }: {
+declare function DocstraProvider({ children, docstraConfig, mdxData }: {
     children: React$1.ReactNode;
     docstraConfig: DocstraConfig;
+    mdxData: mdxDataContent;
 }): react_jsx_runtime.JSX.Element;
 declare function useDocstra(): DocstraContextType;
 
@@ -55,10 +68,8 @@ declare function DocstraPage({ children }: {
 
 interface Props {
     children: React.ReactNode;
-    metadata: any;
-    mdxContent: string;
 }
-declare function DocstraBody({ children, metadata, mdxContent }: Props): react_jsx_runtime.JSX.Element;
+declare function DocstraBody({ children }: Props): react_jsx_runtime.JSX.Element;
 
 declare function DocstraTOC({ mdxFilePath, rawMdxContent }: {
     mdxFilePath: string;

package/dist/client/index.d.ts

@@ -7,10 +7,22 @@ interface DocstraContextType {
     docstraConfig: DocstraConfig;
     openSearchBox: boolean;
     setOpenSearchBox: (open: boolean) => void;
+    mdxData: mdxDataContent;
+}
+interface mdxDataContent {
+    metadata: Record<string, any>;
+    mdxContent: string;
+    rawMdxContent: string;
+    mdxFilePath: string;
 }
 interface DocstraConfig {
     siteName?: string;
     editOnGithub?: boolean;
+    feedback?: {
+        enabled?: boolean;
+        formSyncFormID?: string;
+        watermark?: boolean;
+    };
     formSyncFormID?: string;
     githubRepo?: string;
     navbar?: {
@@ -39,9 +51,10 @@ interface DocsLinkGroup {
     items: DocsLinkItem[];
 }
 
-declare function DocstraProvider({ children, docstraConfig }: {
+declare function DocstraProvider({ children, docstraConfig, mdxData }: {
     children: React$1.ReactNode;
     docstraConfig: DocstraConfig;
+    mdxData: mdxDataContent;
 }): react_jsx_runtime.JSX.Element;
 declare function useDocstra(): DocstraContextType;
 
@@ -55,10 +68,8 @@ declare function DocstraPage({ children }: {
 
 interface Props {
     children: React.ReactNode;
-    metadata: any;
-    mdxContent: string;
 }
-declare function DocstraBody({ children, metadata, mdxContent }: Props): react_jsx_runtime.JSX.Element;
+declare function DocstraBody({ children }: Props): react_jsx_runtime.JSX.Element;
 
 declare function DocstraTOC({ mdxFilePath, rawMdxContent }: {
     mdxFilePath: string;

package/dist/client/index.js

@@ -160,7 +160,8 @@ var import_jsx_runtime2 = require("react/jsx-runtime");
 var DocstraContext = (0, import_react2.createContext)(null);
 function DocstraProvider({
   children,
-  docstraConfig
+  docstraConfig,
+  mdxData
 }) {
   const [openSidebar, setOpenSidebar] = (0, import_react2.useState)(false);
   const [openSearchBox, setOpenSearchBox] = (0, import_react2.useState)(false);
@@ -172,7 +173,8 @@ function DocstraProvider({
         setOpenSidebar,
         docstraConfig,
         openSearchBox,
-        setOpenSearchBox
+        setOpenSearchBox,
+        mdxData
       },
       children: [
         /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(import_react_toast_msg.ToastContainer, {}),
@@ -349,7 +351,8 @@ function DocstraBreadcrumbs() {
 var import_lucide_react5 = require("lucide-react");
 var import_react4 = require("react");
 var import_jsx_runtime8 = require("react/jsx-runtime");
-function DocstraPageButtons({ rawMdxContent }) {
+function DocstraPageButtons() {
+  const { mdxData } = useDocstra();
   const [isCopied, setIsCopied] = (0, import_react4.useState)(false);
   const [href, setHref] = (0, import_react4.useState)(null);
   (0, import_react4.useEffect)(() => {
@@ -357,7 +360,7 @@ function DocstraPageButtons({ rawMdxContent }) {
   }, []);
   const prompt = `Read from this URL: ${href} and explain it to me.`;
   const handleCopy = () => {
-    navigator.clipboard.writeText(rawMdxContent);
+    navigator.clipboard.writeText(mdxData?.rawMdxContent);
     setIsCopied(true);
     setTimeout(() => setIsCopied(false), 3e3);
   };
@@ -389,11 +392,12 @@ function DocstraPageButtons({ rawMdxContent }) {
 
 // src/client/docstra-page-head.tsx
 var import_jsx_runtime9 = require("react/jsx-runtime");
-function DocstraPageHead({ metadata, mdxContent }) {
+function DocstraPageHead() {
+  const { mdxData } = useDocstra();
   return /* @__PURE__ */ (0, import_jsx_runtime9.jsxs)(import_jsx_runtime9.Fragment, { children: [
-    /* @__PURE__ */ (0, import_jsx_runtime9.jsx)("h1", { className: "text-3xl font-bold", children: metadata.title }),
-    /* @__PURE__ */ (0, import_jsx_runtime9.jsx)("p", { className: "my-4 text-gray-500", children: metadata.description }),
-    /* @__PURE__ */ (0, import_jsx_runtime9.jsx)(DocstraPageButtons, { rawMdxContent: mdxContent }),
+    /* @__PURE__ */ (0, import_jsx_runtime9.jsx)("h1", { className: "text-3xl font-bold", children: mdxData?.metadata?.title }),
+    /* @__PURE__ */ (0, import_jsx_runtime9.jsx)("p", { className: "my-4 text-gray-500", children: mdxData?.metadata?.description }),
+    /* @__PURE__ */ (0, import_jsx_runtime9.jsx)(DocstraPageButtons, {}),
     /* @__PURE__ */ (0, import_jsx_runtime9.jsx)("hr", { className: "my-10 border-gray-200" })
   ] });
 }
@@ -530,7 +534,7 @@ function DocstraFeedback() {
       "form",
       {
         className: "flex flex-col gap-2",
-        action: `https://formsync.app/v1/s/${docstraConfig?.formSyncFormID || "your-form-id"}`,
+        action: `https://formsync.app/v1/s/${docstraConfig?.feedback?.formSyncFormID || ""}`,
         method: "POST",
         children: [
           /* @__PURE__ */ (0, import_jsx_runtime12.jsx)(
@@ -548,10 +552,17 @@ function DocstraFeedback() {
           /* @__PURE__ */ (0, import_jsx_runtime12.jsx)("input", { type: "hidden", name: "page", value: window.location.href }),
           /* @__PURE__ */ (0, import_jsx_runtime12.jsx)("input", { type: "hidden", name: "_redirect", value: window.location.href }),
           /* @__PURE__ */ (0, import_jsx_runtime12.jsx)(Button, { label: "Submit", className: "w-max text-sm" }),
-          /* @__PURE__ */ (0, import_jsx_runtime12.jsxs)("p", { className: "text-left text-sm text-gray-500 mt-6", children: [
+          docstraConfig?.feedback?.watermark !== false && /* @__PURE__ */ (0, import_jsx_runtime12.jsxs)("p", { className: "text-left text-sm text-gray-500 mt-6", children: [
             "Powered by",
             " ",
-            /* @__PURE__ */ (0, import_jsx_runtime12.jsx)("a", { href: "https://www.formsync.app?utm_source=formsync-docs", className: "text-gray-800", children: "FormSync" })
+            /* @__PURE__ */ (0, import_jsx_runtime12.jsx)(
+              "a",
+              {
+                href: `https://www.formsync.app?utm_source=${docstraConfig?.githubRepo}`,
+                className: "text-gray-800",
+                children: "FormSync"
+              }
+            )
           ] })
         ]
       }
@@ -605,12 +616,13 @@ function DocstraPagination() {
 
 // src/client/docs-body.tsx
 var import_jsx_runtime14 = require("react/jsx-runtime");
-function DocstraBody({ children, metadata, mdxContent }) {
+function DocstraBody({ children }) {
+  const { docstraConfig } = useDocstra();
   return /* @__PURE__ */ (0, import_jsx_runtime14.jsxs)("main", { className: "flex-1 px-4 md:px-8 py-10 max-w-full text-base/7", children: [
     /* @__PURE__ */ (0, import_jsx_runtime14.jsx)(DocstraBreadcrumbs, {}),
-    /* @__PURE__ */ (0, import_jsx_runtime14.jsx)(DocstraPageHead, { metadata, mdxContent }),
+    /* @__PURE__ */ (0, import_jsx_runtime14.jsx)(DocstraPageHead, {}),
     children,
-    /* @__PURE__ */ (0, import_jsx_runtime14.jsx)(DocstraFeedback, {}),
+    docstraConfig?.feedback?.enabled && /* @__PURE__ */ (0, import_jsx_runtime14.jsx)(DocstraFeedback, {}),
     /* @__PURE__ */ (0, import_jsx_runtime14.jsx)(DocstraPagination, {})
   ] });
 }

package/dist/client/index.mjs

@@ -118,7 +118,8 @@ import { jsx as jsx2, jsxs as jsxs2 } from "react/jsx-runtime";
 var DocstraContext = createContext(null);
 function DocstraProvider({
   children,
-  docstraConfig
+  docstraConfig,
+  mdxData
 }) {
   const [openSidebar, setOpenSidebar] = useState2(false);
   const [openSearchBox, setOpenSearchBox] = useState2(false);
@@ -130,7 +131,8 @@ function DocstraProvider({
         setOpenSidebar,
         docstraConfig,
         openSearchBox,
-        setOpenSearchBox
+        setOpenSearchBox,
+        mdxData
       },
       children: [
         /* @__PURE__ */ jsx2(ToastContainer, {}),
@@ -307,7 +309,8 @@ function DocstraBreadcrumbs() {
 import { CheckIcon, CopyIcon } from "lucide-react";
 import { useEffect as useEffect3, useState as useState3 } from "react";
 import { jsx as jsx8, jsxs as jsxs6 } from "react/jsx-runtime";
-function DocstraPageButtons({ rawMdxContent }) {
+function DocstraPageButtons() {
+  const { mdxData } = useDocstra();
   const [isCopied, setIsCopied] = useState3(false);
   const [href, setHref] = useState3(null);
   useEffect3(() => {
@@ -315,7 +318,7 @@ function DocstraPageButtons({ rawMdxContent }) {
   }, []);
   const prompt = `Read from this URL: ${href} and explain it to me.`;
   const handleCopy = () => {
-    navigator.clipboard.writeText(rawMdxContent);
+    navigator.clipboard.writeText(mdxData?.rawMdxContent);
     setIsCopied(true);
     setTimeout(() => setIsCopied(false), 3e3);
   };
@@ -347,11 +350,12 @@ function DocstraPageButtons({ rawMdxContent }) {
 
 // src/client/docstra-page-head.tsx
 import { Fragment as Fragment3, jsx as jsx9, jsxs as jsxs7 } from "react/jsx-runtime";
-function DocstraPageHead({ metadata, mdxContent }) {
+function DocstraPageHead() {
+  const { mdxData } = useDocstra();
   return /* @__PURE__ */ jsxs7(Fragment3, { children: [
-    /* @__PURE__ */ jsx9("h1", { className: "text-3xl font-bold", children: metadata.title }),
-    /* @__PURE__ */ jsx9("p", { className: "my-4 text-gray-500", children: metadata.description }),
-    /* @__PURE__ */ jsx9(DocstraPageButtons, { rawMdxContent: mdxContent }),
+    /* @__PURE__ */ jsx9("h1", { className: "text-3xl font-bold", children: mdxData?.metadata?.title }),
+    /* @__PURE__ */ jsx9("p", { className: "my-4 text-gray-500", children: mdxData?.metadata?.description }),
+    /* @__PURE__ */ jsx9(DocstraPageButtons, {}),
     /* @__PURE__ */ jsx9("hr", { className: "my-10 border-gray-200" })
   ] });
 }
@@ -488,7 +492,7 @@ function DocstraFeedback() {
       "form",
       {
         className: "flex flex-col gap-2",
-        action: `https://formsync.app/v1/s/${docstraConfig?.formSyncFormID || "your-form-id"}`,
+        action: `https://formsync.app/v1/s/${docstraConfig?.feedback?.formSyncFormID || ""}`,
         method: "POST",
         children: [
           /* @__PURE__ */ jsx12(
@@ -506,10 +510,17 @@ function DocstraFeedback() {
           /* @__PURE__ */ jsx12("input", { type: "hidden", name: "page", value: window.location.href }),
           /* @__PURE__ */ jsx12("input", { type: "hidden", name: "_redirect", value: window.location.href }),
           /* @__PURE__ */ jsx12(Button, { label: "Submit", className: "w-max text-sm" }),
-          /* @__PURE__ */ jsxs9("p", { className: "text-left text-sm text-gray-500 mt-6", children: [
+          docstraConfig?.feedback?.watermark !== false && /* @__PURE__ */ jsxs9("p", { className: "text-left text-sm text-gray-500 mt-6", children: [
             "Powered by",
             " ",
-            /* @__PURE__ */ jsx12("a", { href: "https://www.formsync.app?utm_source=formsync-docs", className: "text-gray-800", children: "FormSync" })
+            /* @__PURE__ */ jsx12(
+              "a",
+              {
+                href: `https://www.formsync.app?utm_source=${docstraConfig?.githubRepo}`,
+                className: "text-gray-800",
+                children: "FormSync"
+              }
+            )
           ] })
         ]
       }
@@ -563,12 +574,13 @@ function DocstraPagination() {
 
 // src/client/docs-body.tsx
 import { jsx as jsx14, jsxs as jsxs11 } from "react/jsx-runtime";
-function DocstraBody({ children, metadata, mdxContent }) {
+function DocstraBody({ children }) {
+  const { docstraConfig } = useDocstra();
   return /* @__PURE__ */ jsxs11("main", { className: "flex-1 px-4 md:px-8 py-10 max-w-full text-base/7", children: [
     /* @__PURE__ */ jsx14(DocstraBreadcrumbs, {}),
-    /* @__PURE__ */ jsx14(DocstraPageHead, { metadata, mdxContent }),
+    /* @__PURE__ */ jsx14(DocstraPageHead, {}),
     children,
-    /* @__PURE__ */ jsx14(DocstraFeedback, {}),
+    docstraConfig?.feedback?.enabled && /* @__PURE__ */ jsx14(DocstraFeedback, {}),
     /* @__PURE__ */ jsx14(DocstraPagination, {})
   ] });
 }

package/dist/server/index.d.mts

@@ -3,6 +3,11 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 interface DocstraConfig {
     siteName?: string;
     editOnGithub?: boolean;
+    feedback?: {
+        enabled?: boolean;
+        formSyncFormID?: string;
+        watermark?: boolean;
+    };
     formSyncFormID?: string;
     githubRepo?: string;
     navbar?: {

package/dist/server/index.d.ts

@@ -3,6 +3,11 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 interface DocstraConfig {
     siteName?: string;
     editOnGithub?: boolean;
+    feedback?: {
+        enabled?: boolean;
+        formSyncFormID?: string;
+        watermark?: boolean;
+    };
     formSyncFormID?: string;
     githubRepo?: string;
     navbar?: {

package/dist/server/index.js

@@ -101,9 +101,6 @@ function CreateHeading({ children, level }) {
   let fontSize;
   let iconSize;
   switch (level) {
-    case 1:
-      fontSize = "text-3xl";
-      break;
     case 2:
       fontSize = "text-2xl";
       iconSize = "size-5";
@@ -124,7 +121,7 @@ function CreateHeading({ children, level }) {
       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)(
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(
     Heading,
     {
       id,
@@ -140,7 +137,7 @@ function CreateHeading({ children, level }) {
 // 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 }),
+  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 }),

package/dist/server/index.mjs

@@ -62,9 +62,6 @@ function CreateHeading({ children, level }) {
   let fontSize;
   let iconSize;
   switch (level) {
-    case 1:
-      fontSize = "text-3xl";
-      break;
     case 2:
       fontSize = "text-2xl";
       iconSize = "size-5";
@@ -85,7 +82,7 @@ function CreateHeading({ children, level }) {
       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(
+  return /* @__PURE__ */ jsxs(
     Heading,
     {
       id,
@@ -101,7 +98,7 @@ function CreateHeading({ children, level }) {
 // src/client/mdx-components.tsx
 import { jsx as jsx2 } from "react/jsx-runtime";
 var defaultMdxComponents = {
-  h1: (props) => /* @__PURE__ */ jsx2(CreateHeading, { ...props, level: 1 }),
+  h1: (props) => /* @__PURE__ */ jsx2("h1", { className: "text-3xl font-bold text-gray-900 mb-4", children: props.children }),
   h2: (props) => /* @__PURE__ */ jsx2(CreateHeading, { ...props, level: 2 }),
   h3: (props) => /* @__PURE__ */ jsx2(CreateHeading, { ...props, level: 3 }),
   h4: (props) => /* @__PURE__ */ jsx2(CreateHeading, { ...props, level: 4 }),

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "docstra",
-    "version": "1.3.0",
+    "version": "1.4.0",
     "description": "A Modern Documentation Framework for Next.js",
     "keywords": [
         "next",