docstra 0.1.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/dist/{index.d.mts → client/index.d.mts} +26 -8
  2. package/dist/{index.d.ts → client/index.d.ts} +26 -8
  3. package/dist/client/index.js +824 -0
  4. package/dist/client/index.mjs +781 -0
  5. package/dist/server/index.d.mts +51 -0
  6. package/dist/server/index.d.ts +51 -0
  7. package/dist/server/index.js +176 -0
  8. package/dist/server/index.mjs +136 -0
  9. package/dist/styles.css +548 -2
  10. package/package.json +32 -8
  11. package/dist/index.js +0 -2
  12. package/dist/index.mjs +0 -2
package/dist/{index.d.mts → client/index.d.mts} RENAMED
@@ -10,8 +10,12 @@ interface DocstraContextType {
10
10
  }
11
11
  interface DocstraConfig {
12
12
  siteName?: string;
13
+ editOnGithub?: boolean;
14
+ formSyncFormID?: string;
15
+ githubRepo?: string;
13
16
  navbar?: {
14
17
  logo?: {
18
+ link: string;
15
19
  src: string;
16
20
  alt: string;
17
21
  className?: string;
@@ -20,7 +24,6 @@ interface DocstraConfig {
20
24
  name: string;
21
25
  href: string;
22
26
  }[];
23
- githubRepo?: string;
24
27
  };
25
28
  sidebar?: {
26
29
  links?: DocsLinkGroup[];
@@ -29,9 +32,7 @@ interface DocstraConfig {
29
32
  interface DocsLinkItem {
30
33
  name: string;
31
34
  href: string;
32
- icon?: React.ComponentType<{
33
- className?: string;
34
- }>;
35
+ icon?: string;
35
36
  }
36
37
  interface DocsLinkGroup {
37
38
  section: string;
@@ -42,11 +43,28 @@ declare function DocstraProvider({ children, docstraConfig }: {
42
43
  children: React$1.ReactNode;
43
44
  docstraConfig: DocstraConfig;
44
45
  }): react_jsx_runtime.JSX.Element;
45
- declare const useDocstra: () => DocstraContextType;
46
+ declare function useDocstra(): DocstraContextType;
46
47
 
47
- declare function DocstraLayout({ children, docstraConfig }: {
48
+ declare function DocstraHeader(): react_jsx_runtime.JSX.Element;
49
+
50
+ declare function DocstraSidebar(): react_jsx_runtime.JSX.Element;
51
+
52
+ declare function DocstraPage({ children }: {
48
53
  children: React.ReactNode;
49
- docstraConfig: DocstraConfig;
50
54
  }): react_jsx_runtime.JSX.Element;
51
55
 
52
- export { type DocsLinkGroup, type DocsLinkItem, type DocstraConfig, type DocstraContextType, DocstraLayout, DocstraProvider, useDocstra };
56
+ interface Props {
57
+ children: React.ReactNode;
58
+ metadata: any;
59
+ mdxContent: string;
60
+ }
61
+ declare function DocstraBody({ children, metadata, mdxContent }: Props): react_jsx_runtime.JSX.Element;
62
+
63
+ declare function DocstraTOC({ mdxFilePath, rawMdxContent }: {
64
+ mdxFilePath: string;
65
+ rawMdxContent: string;
66
+ }): react_jsx_runtime.JSX.Element;
67
+
68
+ declare function DocstraCodeBlock(props: any): react_jsx_runtime.JSX.Element;
69
+
70
+ export { DocstraBody, DocstraCodeBlock, DocstraHeader, DocstraPage, DocstraProvider, DocstraSidebar, DocstraTOC, useDocstra };
package/dist/{index.d.ts → client/index.d.ts} RENAMED
@@ -10,8 +10,12 @@ interface DocstraContextType {
10
10
  }
11
11
  interface DocstraConfig {
12
12
  siteName?: string;
13
+ editOnGithub?: boolean;
14
+ formSyncFormID?: string;
15
+ githubRepo?: string;
13
16
  navbar?: {
14
17
  logo?: {
18
+ link: string;
15
19
  src: string;
16
20
  alt: string;
17
21
  className?: string;
@@ -20,7 +24,6 @@ interface DocstraConfig {
20
24
  name: string;
21
25
  href: string;
22
26
  }[];
23
- githubRepo?: string;
24
27
  };
25
28
  sidebar?: {
26
29
  links?: DocsLinkGroup[];
@@ -29,9 +32,7 @@ interface DocstraConfig {
29
32
  interface DocsLinkItem {
30
33
  name: string;
31
34
  href: string;
32
- icon?: React.ComponentType<{
33
- className?: string;
34
- }>;
35
+ icon?: string;
35
36
  }
36
37
  interface DocsLinkGroup {
37
38
  section: string;
@@ -42,11 +43,28 @@ declare function DocstraProvider({ children, docstraConfig }: {
42
43
  children: React$1.ReactNode;
43
44
  docstraConfig: DocstraConfig;
44
45
  }): react_jsx_runtime.JSX.Element;
45
- declare const useDocstra: () => DocstraContextType;
46
+ declare function useDocstra(): DocstraContextType;
46
47
 
47
- declare function DocstraLayout({ children, docstraConfig }: {
48
+ declare function DocstraHeader(): react_jsx_runtime.JSX.Element;
49
+
50
+ declare function DocstraSidebar(): react_jsx_runtime.JSX.Element;
51
+
52
+ declare function DocstraPage({ children }: {
48
53
  children: React.ReactNode;
49
- docstraConfig: DocstraConfig;
50
54
  }): react_jsx_runtime.JSX.Element;
51
55
 
52
- export { type DocsLinkGroup, type DocsLinkItem, type DocstraConfig, type DocstraContextType, DocstraLayout, DocstraProvider, useDocstra };
56
+ interface Props {
57
+ children: React.ReactNode;
58
+ metadata: any;
59
+ mdxContent: string;
60
+ }
61
+ declare function DocstraBody({ children, metadata, mdxContent }: Props): react_jsx_runtime.JSX.Element;
62
+
63
+ declare function DocstraTOC({ mdxFilePath, rawMdxContent }: {
64
+ mdxFilePath: string;
65
+ rawMdxContent: string;
66
+ }): react_jsx_runtime.JSX.Element;
67
+
68
+ declare function DocstraCodeBlock(props: any): react_jsx_runtime.JSX.Element;
69
+
70
+ export { DocstraBody, DocstraCodeBlock, DocstraHeader, DocstraPage, DocstraProvider, DocstraSidebar, DocstraTOC, useDocstra };