@netfoundry/docusaurus-theme 0.1.3 → 0.1.4

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 (198) hide show
  1. package/dist/src/components/Alert/Alert.d.ts +9 -0
  2. package/dist/src/components/Alert/Alert.d.ts.map +1 -0
  3. package/dist/src/components/Alert/Alert.js +7 -0
  4. package/dist/src/components/Alert/Alert.js.map +1 -0
  5. package/{src/components/Alert/index.ts → dist/src/components/Alert/index.d.ts} +1 -0
  6. package/dist/src/components/Alert/index.d.ts.map +1 -0
  7. package/dist/src/components/Alert/index.js +2 -0
  8. package/dist/src/components/Alert/index.js.map +1 -0
  9. package/dist/src/components/CodeBlock/CodeBlock.d.ts +10 -0
  10. package/dist/src/components/CodeBlock/CodeBlock.d.ts.map +1 -0
  11. package/dist/src/components/CodeBlock/CodeBlock.js +8 -0
  12. package/dist/src/components/CodeBlock/CodeBlock.js.map +1 -0
  13. package/{src/components/CodeBlock/index.ts → dist/src/components/CodeBlock/index.d.ts} +1 -0
  14. package/dist/src/components/CodeBlock/index.d.ts.map +1 -0
  15. package/dist/src/components/CodeBlock/index.js +2 -0
  16. package/dist/src/components/CodeBlock/index.js.map +1 -0
  17. package/dist/src/components/Common/Common.d.ts +24 -0
  18. package/dist/src/components/Common/Common.d.ts.map +1 -0
  19. package/dist/src/components/Common/Common.js +20 -0
  20. package/dist/src/components/Common/Common.js.map +1 -0
  21. package/dist/src/components/Common/index.d.ts +2 -0
  22. package/dist/src/components/Common/index.d.ts.map +1 -0
  23. package/dist/src/components/Common/index.js +2 -0
  24. package/dist/src/components/Common/index.js.map +1 -0
  25. package/dist/src/components/NetFoundry/Divider/Divider.d.ts +3 -0
  26. package/dist/src/components/NetFoundry/Divider/Divider.d.ts.map +1 -0
  27. package/dist/src/components/NetFoundry/Divider/Divider.js +6 -0
  28. package/dist/src/components/NetFoundry/Divider/Divider.js.map +1 -0
  29. package/dist/src/components/NetFoundry/Divider/index.d.ts +2 -0
  30. package/dist/src/components/NetFoundry/Divider/index.d.ts.map +1 -0
  31. package/dist/src/components/NetFoundry/Divider/index.js +2 -0
  32. package/dist/src/components/NetFoundry/Divider/index.js.map +1 -0
  33. package/dist/src/components/NetFoundry/index.d.ts +2 -0
  34. package/dist/src/components/NetFoundry/index.d.ts.map +1 -0
  35. package/dist/src/components/NetFoundry/index.js +2 -0
  36. package/dist/src/components/NetFoundry/index.js.map +1 -0
  37. package/dist/src/components/NetFoundryFooter/NetFoundryFooter.d.ts +23 -0
  38. package/dist/src/components/NetFoundryFooter/NetFoundryFooter.d.ts.map +1 -0
  39. package/dist/src/components/NetFoundryFooter/NetFoundryFooter.js +63 -0
  40. package/dist/src/components/NetFoundryFooter/NetFoundryFooter.js.map +1 -0
  41. package/dist/src/components/NetFoundryFooter/index.d.ts +2 -0
  42. package/dist/src/components/NetFoundryFooter/index.d.ts.map +1 -0
  43. package/{src/components/NetFoundryFooter/index.ts → dist/src/components/NetFoundryFooter/index.js} +2 -1
  44. package/dist/src/components/NetFoundryFooter/index.js.map +1 -0
  45. package/dist/src/components/NetFoundryHighlight/NetFoundryHighlight.d.ts +7 -0
  46. package/dist/src/components/NetFoundryHighlight/NetFoundryHighlight.d.ts.map +1 -0
  47. package/dist/src/components/NetFoundryHighlight/NetFoundryHighlight.js +6 -0
  48. package/dist/src/components/NetFoundryHighlight/NetFoundryHighlight.js.map +1 -0
  49. package/{src/components/NetFoundryHighlight/index.ts → dist/src/components/NetFoundryHighlight/index.d.ts} +3 -2
  50. package/dist/src/components/NetFoundryHighlight/index.d.ts.map +1 -0
  51. package/dist/src/components/NetFoundryHighlight/index.js +2 -0
  52. package/dist/src/components/NetFoundryHighlight/index.js.map +1 -0
  53. package/dist/src/components/NetFoundryHorizontalSection/NetFoundryHorizontalSection.d.ts +9 -0
  54. package/dist/src/components/NetFoundryHorizontalSection/NetFoundryHorizontalSection.d.ts.map +1 -0
  55. package/dist/src/components/NetFoundryHorizontalSection/NetFoundryHorizontalSection.js +8 -0
  56. package/dist/src/components/NetFoundryHorizontalSection/NetFoundryHorizontalSection.js.map +1 -0
  57. package/dist/src/components/NetFoundryHorizontalSection/index.d.ts +3 -0
  58. package/dist/src/components/NetFoundryHorizontalSection/index.d.ts.map +1 -0
  59. package/dist/src/components/NetFoundryHorizontalSection/index.js +2 -0
  60. package/dist/src/components/NetFoundryHorizontalSection/index.js.map +1 -0
  61. package/dist/src/components/NetFoundryLayout/NetFoundryLayout.d.ts +30 -0
  62. package/dist/src/components/NetFoundryLayout/NetFoundryLayout.d.ts.map +1 -0
  63. package/dist/src/components/NetFoundryLayout/NetFoundryLayout.js +35 -0
  64. package/dist/src/components/NetFoundryLayout/NetFoundryLayout.js.map +1 -0
  65. package/dist/src/components/NetFoundryLayout/index.d.ts +2 -0
  66. package/dist/src/components/NetFoundryLayout/index.d.ts.map +1 -0
  67. package/dist/src/components/NetFoundryLayout/index.js +2 -0
  68. package/dist/src/components/NetFoundryLayout/index.js.map +1 -0
  69. package/dist/src/components/NetFoundryNavbarItems/NetFoundryNavbarItems.d.ts +10 -0
  70. package/dist/src/components/NetFoundryNavbarItems/NetFoundryNavbarItems.d.ts.map +1 -0
  71. package/{src/components/NetFoundryNavbarItems/NetFoundryNavbarItems.tsx → dist/src/components/NetFoundryNavbarItems/NetFoundryNavbarItems.js} +14 -22
  72. package/dist/src/components/NetFoundryNavbarItems/NetFoundryNavbarItems.js.map +1 -0
  73. package/dist/src/components/NetFoundryNavbarItems/index.d.ts +3 -0
  74. package/dist/src/components/NetFoundryNavbarItems/index.d.ts.map +1 -0
  75. package/dist/src/components/NetFoundryNavbarItems/index.js +2 -0
  76. package/dist/src/components/NetFoundryNavbarItems/index.js.map +1 -0
  77. package/dist/src/components/OsTabs/OsTabs.d.ts +6 -0
  78. package/dist/src/components/OsTabs/OsTabs.d.ts.map +1 -0
  79. package/dist/src/components/OsTabs/OsTabs.js +18 -0
  80. package/dist/src/components/OsTabs/OsTabs.js.map +1 -0
  81. package/dist/src/components/OsTabs/index.d.ts +3 -0
  82. package/dist/src/components/OsTabs/index.d.ts.map +1 -0
  83. package/dist/src/components/OsTabs/index.js +2 -0
  84. package/dist/src/components/OsTabs/index.js.map +1 -0
  85. package/dist/src/components/StarUs/StarUs.d.ts +7 -0
  86. package/dist/src/components/StarUs/StarUs.d.ts.map +1 -0
  87. package/dist/src/components/StarUs/StarUs.js +7 -0
  88. package/dist/src/components/StarUs/StarUs.js.map +1 -0
  89. package/dist/src/components/StarUs/index.d.ts +3 -0
  90. package/dist/src/components/StarUs/index.d.ts.map +1 -0
  91. package/{src/components/StarUs/index.ts → dist/src/components/StarUs/index.js} +1 -1
  92. package/dist/src/components/StarUs/index.js.map +1 -0
  93. package/dist/src/components/index.d.ts +12 -0
  94. package/dist/src/components/index.d.ts.map +1 -0
  95. package/{src/components/index.ts → dist/src/components/index.js} +3 -2
  96. package/dist/src/components/index.js.map +1 -0
  97. package/dist/src/docusaurus-envhelper.d.ts +16 -0
  98. package/dist/src/docusaurus-envhelper.d.ts.map +1 -0
  99. package/{src/docusaurus-envhelper.ts → dist/src/docusaurus-envhelper.js} +66 -98
  100. package/dist/src/docusaurus-envhelper.js.map +1 -0
  101. package/dist/src/docusaurus-plugins/index.d.ts +8 -0
  102. package/dist/src/docusaurus-plugins/index.d.ts.map +1 -0
  103. package/dist/src/docusaurus-plugins/index.js +8 -0
  104. package/dist/src/docusaurus-plugins/index.js.map +1 -0
  105. package/dist/src/docusaurus-plugins/logger.d.ts +13 -0
  106. package/dist/src/docusaurus-plugins/logger.d.ts.map +1 -0
  107. package/dist/src/docusaurus-plugins/logger.js +41 -0
  108. package/dist/src/docusaurus-plugins/logger.js.map +1 -0
  109. package/dist/src/docusaurus-plugins/remarkCodeSections.d.ts +8 -0
  110. package/dist/src/docusaurus-plugins/remarkCodeSections.d.ts.map +1 -0
  111. package/dist/src/docusaurus-plugins/remarkCodeSections.js +96 -0
  112. package/dist/src/docusaurus-plugins/remarkCodeSections.js.map +1 -0
  113. package/dist/src/docusaurus-plugins/remarkReplaceMetaUrl.d.ts +11 -0
  114. package/dist/src/docusaurus-plugins/remarkReplaceMetaUrl.d.ts.map +1 -0
  115. package/dist/src/docusaurus-plugins/remarkReplaceMetaUrl.js +23 -0
  116. package/dist/src/docusaurus-plugins/remarkReplaceMetaUrl.js.map +1 -0
  117. package/dist/src/docusaurus-plugins/remarkScopedPath.d.ts +13 -0
  118. package/dist/src/docusaurus-plugins/remarkScopedPath.d.ts.map +1 -0
  119. package/dist/src/docusaurus-plugins/remarkScopedPath.js +48 -0
  120. package/dist/src/docusaurus-plugins/remarkScopedPath.js.map +1 -0
  121. package/dist/src/docusaurus-plugins/remarkYamlTable.d.ts +8 -0
  122. package/dist/src/docusaurus-plugins/remarkYamlTable.d.ts.map +1 -0
  123. package/dist/src/docusaurus-plugins/remarkYamlTable.js +50 -0
  124. package/dist/src/docusaurus-plugins/remarkYamlTable.js.map +1 -0
  125. package/dist/src/docusaurus-plugins/remarkYouTube.d.ts +8 -0
  126. package/dist/src/docusaurus-plugins/remarkYouTube.d.ts.map +1 -0
  127. package/dist/src/docusaurus-plugins/remarkYouTube.js +44 -0
  128. package/dist/src/docusaurus-plugins/remarkYouTube.js.map +1 -0
  129. package/dist/src/docusaurus-plugins/timedPlugin.d.ts +6 -0
  130. package/dist/src/docusaurus-plugins/timedPlugin.d.ts.map +1 -0
  131. package/dist/src/docusaurus-plugins/timedPlugin.js +16 -0
  132. package/dist/src/docusaurus-plugins/timedPlugin.js.map +1 -0
  133. package/dist/src/index.d.ts +5 -0
  134. package/dist/src/index.d.ts.map +1 -0
  135. package/dist/src/index.js +32 -0
  136. package/dist/src/index.js.map +1 -0
  137. package/dist/src/node.d.ts +7 -0
  138. package/dist/src/node.d.ts.map +1 -0
  139. package/{src/node.ts → dist/src/node.js} +7 -6
  140. package/dist/src/node.js.map +1 -0
  141. package/{src/options.ts → dist/src/options.d.ts} +90 -95
  142. package/dist/src/options.d.ts.map +1 -0
  143. package/dist/src/options.js +2 -0
  144. package/dist/src/options.js.map +1 -0
  145. package/dist/src/plugins.d.ts +7 -0
  146. package/dist/src/plugins.d.ts.map +1 -0
  147. package/{src/plugins.ts → dist/src/plugins.js} +7 -6
  148. package/dist/src/plugins.js.map +1 -0
  149. package/dist/src/ui.d.ts +8 -0
  150. package/dist/src/ui.d.ts.map +1 -0
  151. package/{src/ui.ts → dist/src/ui.js} +8 -7
  152. package/dist/src/ui.js.map +1 -0
  153. package/dist/src/version.d.ts +2 -0
  154. package/dist/src/version.d.ts.map +1 -0
  155. package/dist/src/version.js +2 -0
  156. package/dist/src/version.js.map +1 -0
  157. package/dist/theme/Layout/index.d.ts +19 -0
  158. package/dist/theme/Layout/index.d.ts.map +1 -0
  159. package/dist/theme/Layout/index.js +39 -0
  160. package/dist/theme/Layout/index.js.map +1 -0
  161. package/package.json +23 -15
  162. package/src/components/Alert/Alert.tsx +0 -24
  163. package/src/components/CodeBlock/CodeBlock.tsx +0 -32
  164. package/src/components/Common/Common.tsx +0 -53
  165. package/src/components/Common/index.ts +0 -1
  166. package/src/components/NetFoundry/Divider/Divider.tsx +0 -20
  167. package/src/components/NetFoundry/Divider/index.ts +0 -1
  168. package/src/components/NetFoundry/index.ts +0 -1
  169. package/src/components/NetFoundryFooter/NetFoundryFooter.tsx +0 -164
  170. package/src/components/NetFoundryHighlight/NetFoundryHighlight.tsx +0 -15
  171. package/src/components/NetFoundryHorizontalSection/NetFoundryHorizontalSection.tsx +0 -23
  172. package/src/components/NetFoundryHorizontalSection/index.ts +0 -2
  173. package/src/components/NetFoundryLayout/NetFoundryLayout.tsx +0 -110
  174. package/src/components/NetFoundryLayout/index.ts +0 -1
  175. package/src/components/NetFoundryNavbarItems/index.ts +0 -2
  176. package/src/components/OsTabs/OsTabs.tsx +0 -30
  177. package/src/components/OsTabs/index.ts +0 -2
  178. package/src/components/StarUs/StarUs.tsx +0 -19
  179. package/src/docusaurus-plugins/index.ts +0 -7
  180. package/src/docusaurus-plugins/logger.ts +0 -38
  181. package/src/docusaurus-plugins/remarkCodeSections.ts +0 -115
  182. package/src/docusaurus-plugins/remarkReplaceMetaUrl.ts +0 -35
  183. package/src/docusaurus-plugins/remarkScopedPath.ts +0 -70
  184. package/src/docusaurus-plugins/remarkYamlTable.ts +0 -83
  185. package/src/docusaurus-plugins/remarkYouTube.ts +0 -56
  186. package/src/docusaurus-plugins/timedPlugin.ts +0 -22
  187. package/src/index.ts +0 -46
  188. package/src/version.ts +0 -1
  189. package/theme/Layout/index.tsx +0 -74
  190. /package/{src → dist/src}/components/Alert/Alert.module.css +0 -0
  191. /package/{src → dist/src}/components/CodeBlock/CodeBlock.module.css +0 -0
  192. /package/{src → dist/src}/components/Common/Common.module.css +0 -0
  193. /package/{src → dist/src}/components/NetFoundry/Divider/Divider.module.css +0 -0
  194. /package/{src → dist/src}/components/NetFoundryFooter/styles.module.css +0 -0
  195. /package/{src → dist/src}/components/NetFoundryHighlight/styles.module.css +0 -0
  196. /package/{src → dist/src}/components/NetFoundryHorizontalSection/styles.module.css +0 -0
  197. /package/{src → dist/src}/components/NetFoundryLayout/NetFoundryLayout.module.css +0 -0
  198. /package/{src → dist/src}/components/StarUs/styles.module.css +0 -0
@@ -1,7 +1,8 @@
1
- /**
2
- * UI components entry point
3
- *
4
- * Import from '@netfoundry/docusaurus-theme/ui' in client code.
5
- */
6
- export * from './components';
7
- export * from './docusaurus-envhelper';
1
+ /**
2
+ * UI components entry point
3
+ *
4
+ * Import from '@netfoundry/docusaurus-theme/ui' in client code.
5
+ */
6
+ export * from './components';
7
+ export * from './docusaurus-envhelper';
8
+ //# sourceMappingURL=ui.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ui.js","sourceRoot":"","sources":["../../src/ui.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC"}
@@ -0,0 +1,2 @@
1
+ export declare const version = "0.1.1";
2
+ //# sourceMappingURL=version.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
@@ -0,0 +1,2 @@
1
+ export const version = '0.1.1';
2
+ //# sourceMappingURL=version.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC"}
@@ -0,0 +1,19 @@
1
+ import { type ReactNode } from 'react';
2
+ export interface LayoutProps {
3
+ children: ReactNode;
4
+ noFooter?: boolean;
5
+ wrapperClassName?: string;
6
+ title?: string;
7
+ description?: string;
8
+ }
9
+ /**
10
+ * NetFoundry theme Layout component.
11
+ *
12
+ * This component wraps NetFoundryLayout and reads configuration from
13
+ * themeConfig.netfoundry in docusaurus.config.ts.
14
+ *
15
+ * To customize further, swizzle this component:
16
+ * npx docusaurus swizzle @netfoundry/docusaurus-theme Layout --wrap
17
+ */
18
+ export default function Layout({ children, noFooter, wrapperClassName, title, description, }: LayoutProps): ReactNode;
19
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../theme/Layout/index.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAS9C,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,SAAS,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,EAC7B,QAAQ,EACR,QAAQ,EACR,gBAAgB,EAChB,KAAK,EACL,WAAW,GACZ,EAAE,WAAW,GAAG,SAAS,CAyCzB"}
@@ -0,0 +1,39 @@
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
3
+ import { NetFoundryLayout, defaultNetFoundryFooterProps, defaultSocialProps, } from '../../src/ui';
4
+ /**
5
+ * NetFoundry theme Layout component.
6
+ *
7
+ * This component wraps NetFoundryLayout and reads configuration from
8
+ * themeConfig.netfoundry in docusaurus.config.ts.
9
+ *
10
+ * To customize further, swizzle this component:
11
+ * npx docusaurus swizzle @netfoundry/docusaurus-theme Layout --wrap
12
+ */
13
+ export default function Layout({ children, noFooter, wrapperClassName, title, description, }) {
14
+ const { siteConfig } = useDocusaurusContext();
15
+ const themeConfig = siteConfig.themeConfig;
16
+ const nfConfig = themeConfig.netfoundry ?? {};
17
+ // Build footer props from config, falling back to defaults
18
+ const footerProps = noFooter
19
+ ? undefined
20
+ : {
21
+ ...defaultNetFoundryFooterProps(),
22
+ ...nfConfig.footer,
23
+ socialProps: {
24
+ ...defaultSocialProps,
25
+ ...nfConfig.footer?.socialProps,
26
+ },
27
+ };
28
+ // Build star props if enabled
29
+ const starProps = nfConfig.showStarBanner && nfConfig.starBanner
30
+ ? {
31
+ repoUrl: nfConfig.starBanner.repoUrl,
32
+ label: nfConfig.starBanner.label,
33
+ }
34
+ : undefined;
35
+ return (_jsx(NetFoundryLayout, { title: title, description: description, className: wrapperClassName, noFooter: noFooter, footerProps: footerProps, starProps: starProps, meta: {
36
+ siteName: siteConfig.title,
37
+ }, children: children }));
38
+ }
39
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../theme/Layout/index.tsx"],"names":[],"mappings":";AACA,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,EACL,gBAAgB,EAChB,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,cAAc,CAAC;AAWtB;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,EAC7B,QAAQ,EACR,QAAQ,EACR,gBAAgB,EAChB,KAAK,EACL,WAAW,GACC;IACZ,MAAM,EAAE,UAAU,EAAE,GAAG,oBAAoB,EAAE,CAAC;IAC9C,MAAM,WAAW,GAAG,UAAU,CAAC,WAAwC,CAAC;IACxE,MAAM,QAAQ,GAAG,WAAW,CAAC,UAAU,IAAI,EAAE,CAAC;IAE9C,2DAA2D;IAC3D,MAAM,WAAW,GAAG,QAAQ;QAC1B,CAAC,CAAC,SAAS;QACX,CAAC,CAAC;YACE,GAAG,4BAA4B,EAAE;YACjC,GAAG,QAAQ,CAAC,MAAM;YAClB,WAAW,EAAE;gBACX,GAAG,kBAAkB;gBACrB,GAAG,QAAQ,CAAC,MAAM,EAAE,WAAW;aAChC;SACF,CAAC;IAEN,8BAA8B;IAC9B,MAAM,SAAS,GACb,QAAQ,CAAC,cAAc,IAAI,QAAQ,CAAC,UAAU;QAC5C,CAAC,CAAC;YACE,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,OAAO;YACpC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,KAAK;SACjC;QACH,CAAC,CAAC,SAAS,CAAC;IAEhB,OAAO,CACL,KAAC,gBAAgB,IACf,KAAK,EAAE,KAAK,EACZ,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,gBAAgB,EAC3B,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE;YACJ,QAAQ,EAAE,UAAU,CAAC,KAAK;SAC3B,YAEA,QAAQ,GACQ,CACpB,CAAC;AACJ,CAAC"}
package/package.json CHANGED
@@ -1,38 +1,39 @@
1
1
  {
2
2
  "name": "@netfoundry/docusaurus-theme",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "description": "NetFoundry Docusaurus theme with shared layout, footer, and styling",
5
- "main": "src/index.ts",
6
- "types": "src/index.ts",
5
+ "main": "dist/src/index.js",
6
+ "types": "dist/src/index.d.ts",
7
7
  "files": [
8
- "src",
9
- "theme",
8
+ "dist",
10
9
  "css"
11
10
  ],
12
11
  "scripts": {
13
- "build": "echo 'No build needed - theme uses source files directly'",
12
+ "clean": "rm -rf dist",
13
+ "build": "yarn clean && tsc && yarn build:css",
14
+ "build:css": "find src -name '*.css' -exec sh -c 'mkdir -p dist/$(dirname {}) && cp {} dist/{}' \\;",
14
15
  "test": "jest",
15
- "prepublishOnly": "yarn test"
16
+ "prepublishOnly": "yarn build && yarn test"
16
17
  },
17
18
  "publishConfig": {
18
19
  "access": "public"
19
20
  },
20
21
  "exports": {
21
22
  ".": {
22
- "types": "./src/index.ts",
23
- "default": "./src/index.ts"
23
+ "types": "./dist/src/index.d.ts",
24
+ "default": "./dist/src/index.js"
24
25
  },
25
26
  "./ui": {
26
- "types": "./src/ui.ts",
27
- "default": "./src/ui.ts"
27
+ "types": "./dist/src/ui.d.ts",
28
+ "default": "./dist/src/ui.js"
28
29
  },
29
30
  "./plugins": {
30
- "types": "./src/plugins.ts",
31
- "default": "./src/plugins.ts"
31
+ "types": "./dist/src/plugins.d.ts",
32
+ "default": "./dist/src/plugins.js"
32
33
  },
33
34
  "./node": {
34
- "types": "./src/node.ts",
35
- "default": "./src/node.ts"
35
+ "types": "./dist/src/node.d.ts",
36
+ "default": "./dist/src/node.js"
36
37
  },
37
38
  "./css/*": "./css/*"
38
39
  },
@@ -49,8 +50,15 @@
49
50
  "react-github-btn": "^1.4.0"
50
51
  },
51
52
  "devDependencies": {
53
+ "@docusaurus/core": "^3",
54
+ "@docusaurus/theme-classic": "^3",
55
+ "@docusaurus/theme-common": "^3",
52
56
  "@docusaurus/types": "^3",
57
+ "@types/react": "^18",
58
+ "@types/react-dom": "^18",
53
59
  "jest": "^30.0.4",
60
+ "react": "^18",
61
+ "react-dom": "^18",
54
62
  "typescript": "^5"
55
63
  },
56
64
  "repository": {
@@ -1,24 +0,0 @@
1
- import React from 'react';
2
- import clsx from 'clsx';
3
- import styles from './Alert.module.css';
4
-
5
- export interface AlertProps {
6
- type?: 'info' | 'warning' | 'error' | 'success';
7
- title?: string;
8
- children: React.ReactNode;
9
- className?: string;
10
- }
11
-
12
- export const Alert: React.FC<AlertProps> = ({
13
- type = 'info',
14
- title,
15
- children,
16
- className
17
- }) => {
18
- return (
19
- <div className={clsx(styles.alert, styles[type], className)}>
20
- {title && <div className={styles.title}>{title}</div>}
21
- <div className={styles.content}>{children}</div>
22
- </div>
23
- );
24
- };
@@ -1,32 +0,0 @@
1
- import React from 'react';
2
- import { useThemeConfig } from '@docusaurus/theme-common';
3
- import styles from './CodeBlock.module.css';
4
-
5
- export interface CodeBlockProps {
6
- children: string;
7
- language?: string;
8
- title?: string;
9
- showLineNumbers?: boolean;
10
- className?: string;
11
- }
12
-
13
- export const CodeBlock: React.FC<CodeBlockProps> = ({
14
- children,
15
- language = 'text',
16
- title,
17
- showLineNumbers = false,
18
- className
19
- }) => {
20
- const { prism } = useThemeConfig();
21
-
22
- return (
23
- <div className={`${styles.codeBlock} ${className || ''}`}>
24
- {title && <div className={styles.title}>{title}</div>}
25
- <pre className={`language-${language}`}>
26
- <code className={`language-${language}`}>
27
- {children}
28
- </code>
29
- </pre>
30
- </div>
31
- );
32
- };
@@ -1,53 +0,0 @@
1
- import React, { JSX } from 'react';
2
- import clsx from 'clsx';
3
- import styles from './Common.module.css';
4
-
5
- export interface H1Props {
6
- children: React.ReactNode;
7
- id?: string;
8
- className?: string;
9
- }
10
-
11
- export interface H2Props {
12
- children: React.ReactNode;
13
- className?: string;
14
- }
15
-
16
- export interface H3Props {
17
- children: React.ReactNode;
18
- style?: React.CSSProperties;
19
- className?: string;
20
- }
21
-
22
- export interface HighlightProps {
23
- children: React.ReactNode;
24
- className?: string;
25
- }
26
-
27
- export function H1(props: H1Props): JSX.Element {
28
- const {children, id, className} = props;
29
- return (
30
- <p id={id} className={clsx(styles.h1, className)}>{children}</p>
31
- );
32
- }
33
-
34
- export function H2(props: H2Props): JSX.Element {
35
- const {children, className} = props;
36
- return (
37
- <p className={clsx(styles.h2, className)}>{children}</p>
38
- );
39
- }
40
-
41
- export function H3(props: H3Props): JSX.Element {
42
- const {children, style, className} = props;
43
- return (
44
- <h3 className={clsx(styles.h3, className)} style={style}>{children}</h3>
45
- );
46
- }
47
-
48
- export function Highlight(props: HighlightProps): JSX.Element {
49
- const { children, className } = props;
50
- return (
51
- <span className={clsx(styles.highlight, className)}>{children}</span>
52
- );
53
- }
@@ -1 +0,0 @@
1
- export * from './Common';
@@ -1,20 +0,0 @@
1
- import React, {JSX} from 'react';
2
- import styles from './Divider.module.css';
3
-
4
- export function Divider(): JSX.Element {
5
- return (
6
- <div className={styles.onpremConnector}>
7
- <div className={styles.onpremDot} aria-hidden="true">
8
- <svg viewBox="0 0 24 24" role="img" aria-label="endpoint">
9
- <circle cx="12" cy="12" r="8" fill="currentColor" />
10
- </svg>
11
- </div>
12
- <div className={styles.onpremLine} role="presentation" aria-hidden="true"></div>
13
- <div className={styles.onpremDot} aria-hidden="true">
14
- <svg viewBox="0 0 24 24" role="img" aria-label="endpoint">
15
- <circle cx="12" cy="12" r="8" fill="currentColor" />
16
- </svg>
17
- </div>
18
- </div>
19
- );
20
- }
@@ -1 +0,0 @@
1
- export * from './Divider'
@@ -1 +0,0 @@
1
- export * from './Divider'
@@ -1,164 +0,0 @@
1
- import React, {CSSProperties, ReactNode} from 'react';
2
- import clsx from 'clsx';
3
- import {NetFoundryHorizontalSection} from "../NetFoundryHorizontalSection";
4
- import useBaseUrl from "@docusaurus/useBaseUrl";
5
- import styles from './styles.module.css';
6
-
7
- export interface SocialProps {
8
- twitterUrl?: string;
9
- linkedInUrl?: string;
10
- githubUrl?: string;
11
- facebookUrl?: string;
12
- instagramUrl?: string;
13
- youtubeUrl?: string;
14
- }
15
- export const defaultSocialProps: SocialProps = {
16
- twitterUrl: '',
17
- linkedInUrl: '',
18
- githubUrl: '',
19
- facebookUrl: '',
20
- instagramUrl: '',
21
- youtubeUrl: '',
22
- };
23
-
24
- export type NetFoundryFooterProps = {
25
- className?: string;
26
- style?: CSSProperties;
27
- description?: string;
28
- socialProps?: SocialProps;
29
- documentationLinks?: React.ReactNode[];
30
- communityLinks?: React.ReactNode[];
31
- resourceLinks?: React.ReactNode[];
32
- children?: ReactNode;
33
- };
34
-
35
- export function defaultNetFoundryFooterProps(overrides?: Partial<NetFoundryFooterProps>): NetFoundryFooterProps {
36
- return {
37
- description: 'Self-hosted OpenZiti for enterprises needing compliance, control, and support.',
38
- socialProps: {
39
- githubUrl: 'https://github.com/openziti/ziti',
40
- linkedInUrl: 'https://www.linkedin.com/company/netfoundry',
41
- youtubeUrl: 'https://www.youtube.com/OpenZiti',
42
- twitterUrl: 'https://x.com/OpenZiti'
43
- },
44
- documentationLinks: [
45
- <a href="/docs/openziti/learn/quickstarts/services/ztha">Getting Started</a>,
46
- <a href="/docs/openziti/reference/developer/api/">API Reference</a>,
47
- <a href="/docs/openziti/reference/developer/sdk/">SDK Integration</a>,
48
- ],
49
- communityLinks: [
50
- <a href="https://github.com/openziti/ziti">GitHub</a>,
51
- <a href="https://openziti.discourse.group/">Discourse Forum</a>,
52
- <a href="/docs/openziti/policies/CONTRIBUTING">Contributing</a>,
53
- ],
54
- resourceLinks: [
55
- <a href="https://blog.openziti.io">OpenZiti Tech Blog</a>,
56
- <a href="https://netfoundry.io/">NetFoundry</a>,
57
- ],
58
- ...overrides
59
- };
60
- }
61
-
62
- function ListBlock({title, items}:{title:string; items?: React.ReactNode[]}) {
63
- if (!items?.length) return null;
64
- return (
65
- <div className={styles.footerColumn}>
66
- <h3>{title}</h3>
67
- <ul className={styles.footerLinks}>
68
- {items.map((item, i) => <li key={i}>{item}</li>)}
69
- </ul>
70
- </div>
71
- );
72
- }
73
-
74
- export function NetFoundryFooter(props: NetFoundryFooterProps) {
75
- const { className, style, children, description } = props;
76
- const sp = {...defaultSocialProps, ...(props.socialProps ?? {})};
77
-
78
- if (children) return <>{children}</>;
79
-
80
- return (
81
- <footer className={clsx(className, styles.ozFooter)} style={style}>
82
- <NetFoundryHorizontalSection className={styles.footer}>
83
- <div className={styles.footerContainer}>
84
- <div className={styles.footerGrid}>
85
- <div className={styles.footerColumn}>
86
- <h3>NetFoundry</h3>
87
- <p>{description ?? 'An open source project enabling developers to embed zero trust networking directly into applications.'}</p>
88
- <div className={styles.footerSocialLinks}>
89
- {sp.githubUrl && (
90
- <a href={sp.githubUrl} target="_blank" className={styles.footerSocialLink} rel="noreferrer">
91
- <svg width="20" height="20" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
92
- <path d="M8 0C3.58 0 0 3.58 0 8C0 11.54 2.29 14.53 5.47 15.59C5.87 15.66 6.02 15.42 6.02 15.21C6.02 15.02 6.01 14.39 6.01 13.72C4 14.09 3.48 13.23 3.32 12.78C3.23 12.55 2.84 11.84 2.5 11.65C2.22 11.5 1.82 11.13 2.49 11.12C3.12 11.11 3.57 11.7 3.72 11.94C4.44 13.15 5.59 12.81 6.05 12.6C6.12 12.08 6.33 11.73 6.56 11.53C4.78 11.33 2.92 10.64 2.92 7.58C2.92 6.71 3.23 5.99 3.74 5.43C3.66 5.23 3.38 4.41 3.82 3.31C3.82 3.31 4.49 3.1 6.02 4.13C6.66 3.95 7.34 3.86 8.02 3.86C8.7 3.86 9.38 3.95 10.02 4.13C11.55 3.09 12.22 3.31 12.22 3.31C12.66 4.41 12.38 5.23 12.3 5.43C12.81 5.99 13.12 6.7 13.12 7.58C13.12 10.65 11.25 11.33 9.47 11.53C9.76 11.78 10.01 12.26 10.01 13.01C10.01 14.08 10 14.94 10 15.21C10 15.42 10.15 15.67 10.55 15.59C13.71 14.53 16 11.53 16 8C16 3.58 12.42 0 8 0Z"/>
93
- </svg>
94
- </a>
95
- )}
96
- {sp.linkedInUrl && (
97
- <a href={sp.linkedInUrl} target="_blank" className={styles.footerSocialLink} rel="noreferrer">
98
- <svg width="16" height="16" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
99
- <path d="M15.996 16V10.1C15.996 7.5 15.375 5.49999 12.025 5.49999C10.4 5.49999 9.325 6.39999 8.875 7.29999H8.825V5.79999H5.65V16H8.95V10.7C8.95 9.30001 9.2 7.9 10.925 7.9C12.65 7.9 12.675 9.59999 12.675 10.8V16H15.996Z"/>
100
- <path d="M0.25 5.79999H3.575V16H0.25V5.79999Z"/>
101
- <path d="M1.9 0C0.85 0 0 0.85 0 1.9C0 2.95 0.85 3.8 1.9 3.8C2.95 3.8 3.8 2.95 3.8 1.9C3.8 0.85 2.95 0 1.9 0Z"/>
102
- </svg>
103
- </a>
104
- )}
105
- {sp.youtubeUrl && (
106
- <a href={sp.youtubeUrl} target="_blank" className={styles.footerSocialLink} rel="noreferrer">
107
- <svg width="16" height="16" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
108
- <path d="M15.969 4.69c-.183-1.358-1.062-2.275-2.361-2.46C12.371 2 8 2 8 2S3.629 2 2.362 2.229c-1.3.186-2.179 1.103-2.361 2.461C0 6.03 0 10 0 10s0 3.97.2 5.31c.183 1.358 1.062 2.275 2.361 2.46C3.63 18 8 18 8 18s4.371 0 5.638-.23c1.3-.185 2.178-1.102 2.361-2.46.2-1.34.2-5.31.2-5.31s0-3.97-.23-5.31zm-8.36, 8.57V6.73l3.76 2.27-3.76 2.26z"/>
109
- </svg>
110
- </a>
111
- )}
112
- {sp.twitterUrl && (
113
- <a href={sp.twitterUrl} target="_blank" className={styles.footerSocialLink} rel="noreferrer">
114
- <svg width="16" height="16" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
115
- <path d="M15.996 3.038c-.59.262-1.219.44-1.885.52.677-.406 1.194-1.05 1.438-1.815-.634.375-1.337.648-2.085.795-.598-.638-1.45-1.038-2.396-1.038-1.813 0-3.283 1.469-3.283 3.282 0 .257.03.507.085.748-2.728-.137-5.147-1.445-6.766-3.43-.282.485-.444 1.05-.444 1.651 0 1.14.58 2.143 1.46 2.732-.538-.017-1.044-.164-1.487-.41v.04c0 1.59 1.13 2.918 2.633 3.219-.276.075-.567.116-.866.116-.211 0-.416-.021-.617-.06.418 1.304 1.63 2.254 3.066 2.28-1.124.883-2.539 1.406-4.077 1.406-.265 0-.526-.015-.785-.046 1.453.933 3.178 1.475 5.032 1.475 6.038 0 9.34-5.002 9.34-9.34 0-.142-.004-.284-.01-.425.641-.463 1.198-1.039 1.638-1.696"/>
116
- </svg>
117
- </a>
118
- )}
119
- {sp.facebookUrl && (
120
- <a href={sp.facebookUrl} target="_blank" className={styles.footerSocialLink} rel="noreferrer">
121
- <span>f</span>
122
- </a>
123
- )}
124
- {sp.instagramUrl && (
125
- <a href={sp.instagramUrl} target="_blank" className={styles.footerSocialLink} rel="noreferrer">
126
- <span>ig</span>
127
- </a>
128
- )}
129
- </div>
130
- </div>
131
-
132
- <ListBlock
133
- title="Documentation"
134
- items={props.documentationLinks ?? [
135
- <a href={useBaseUrl("/docs/learn/quickstarts/services/ztha")}>Getting Started</a>,
136
- <a href={useBaseUrl("/docs/reference/developer/api/")}>API Reference</a>,
137
- <a href={useBaseUrl("/docs/reference/developer/sdk/")}>SDK Integration</a>,
138
- ]}
139
- />
140
- <ListBlock
141
- title="Community"
142
- items={props.communityLinks ?? [
143
- <a href="https://github.com/openziti/ziti">GitHub</a>,
144
- <a href="https://openziti.discourse.group/">Discourse Forum</a>,
145
- <a href="/docs/openziti/policies/CONTRIBUTING">Contributing</a>,
146
- ]}
147
- />
148
- <ListBlock
149
- title="Resources"
150
- items={props.resourceLinks ?? [
151
- <a href="https://blog.openziti.io">OpenZiti Tech Blog</a>,
152
- <a href="https://netfoundry.io/">NetFoundry</a>,
153
- ]}
154
- />
155
- </div>
156
- </div>
157
-
158
- <div className={styles.footerCopyright}>
159
- <p>© 2025 NetFoundry Inc. OpenZiti is an open source project sponsored by NetFoundry. All rights reserved.</p>
160
- </div>
161
- </NetFoundryHorizontalSection>
162
- </footer>
163
- );
164
- }
@@ -1,15 +0,0 @@
1
- import React, { ReactNode, CSSProperties } from 'react';
2
-
3
- export type NetFoundryHighlightProps = {
4
- children?: ReactNode;
5
- style?: CSSProperties;
6
- };
7
-
8
- export function NetFoundryHighlight(props: NetFoundryHighlightProps) {
9
- const { children, style } = props;
10
- return (
11
- <span style={style}>
12
- <span style={{ color: 'var(--ifm-color-primary)' }}>{children}</span>
13
- </span>
14
- );
15
- }
@@ -1,23 +0,0 @@
1
- import React, { ReactNode, CSSProperties } from 'react';
2
- import clsx from 'clsx';
3
- import styles from './styles.module.css';
4
-
5
- export type NetFoundryHorizontalSectionProps = {
6
- children?: ReactNode;
7
- className?: string;
8
- style?: CSSProperties;
9
- id?: string;
10
- };
11
-
12
- export function NetFoundryHorizontalSection(props: NetFoundryHorizontalSectionProps) {
13
- const { children, className, style, id } = props;
14
- return (
15
- <section
16
- className={clsx(className, styles.ozHorizontalSectionRoot, styles.ozhsContent)}
17
- style={style}
18
- id={id}
19
- >
20
- {children}
21
- </section>
22
- );
23
- }
@@ -1,2 +0,0 @@
1
- export { NetFoundryHorizontalSection } from './NetFoundryHorizontalSection';
2
- export type { NetFoundryHorizontalSectionProps } from './NetFoundryHorizontalSection';
@@ -1,110 +0,0 @@
1
- import React, {JSX} from "react";
2
- import clsx from "clsx";
3
- import ErrorBoundary from "@docusaurus/ErrorBoundary";
4
- import { ThemeClassNames } from "@docusaurus/theme-common";
5
- // @ts-ignore
6
- import { useKeyboardNavigation } from "@docusaurus/theme-common/internal";
7
- import Head from "@docusaurus/Head";
8
- import useBaseUrl from "@docusaurus/useBaseUrl";
9
-
10
- import SkipToContent from "@theme/SkipToContent";
11
- import AnnouncementBar from "@theme/AnnouncementBar";
12
- import Navbar from "@theme/Navbar";
13
- import LayoutProvider from "@theme/Layout/Provider";
14
- import ErrorPageContent from "@theme/ErrorPageContent";
15
- import styles from "./NetFoundryLayout.module.css";
16
-
17
- import { NetFoundryFooter, NetFoundryFooterProps } from "../NetFoundryFooter";
18
- import { StarUs, StarUsProps } from "../StarUs";
19
- import { version } from '../../version';
20
-
21
- export interface MetaProps {
22
- title?: string;
23
- description?: string;
24
- url?: string;
25
- image?: string;
26
- siteName?: string;
27
- locale?: string;
28
- twitterX?: {
29
- card?: "summary" | "summary_large_image" | "player" | "app";
30
- site?: string;
31
- creator?: string;
32
- imageAlt?: string;
33
- };
34
- }
35
-
36
- export interface NetFoundryLayoutProps {
37
- children: React.ReactNode;
38
- noFooter?: boolean;
39
- className?: string;
40
- footerClassName?: string;
41
- title?: string;
42
- description?: string;
43
- starProps?: StarUsProps;
44
- footerProps?: NetFoundryFooterProps;
45
- meta?: MetaProps;
46
- }
47
-
48
- function useAbs() {
49
- return (p?: string) => {
50
- if (!p) return undefined;
51
- if (p.startsWith("http")) return p;
52
- return new URL(useBaseUrl(p), window.location.origin).toString();
53
- };
54
- }
55
-
56
- export function NetFoundryLayout({
57
- children,
58
- noFooter,
59
- className,
60
- title,
61
- description,
62
- starProps = { repoUrl: "", label: "Star us on GitHub" },
63
- footerProps,
64
- meta: metaInput = {},
65
- }: NetFoundryLayoutProps): JSX.Element {
66
- useKeyboardNavigation();
67
-
68
- const abs = useAbs();
69
- const meta = metaInput;
70
- const pageTitle =
71
- (meta.title ?? title ?? "") +
72
- (meta.siteName ? ` | ${meta.siteName}` : "");
73
-
74
- return (
75
- <LayoutProvider>
76
- <Head>
77
- <title>{pageTitle}</title>
78
- <meta data-rh="true" name="nf-layout-version" content={version} />
79
- {(meta.description ?? description) && (<meta name="description" content={meta.description ?? description} />)}
80
- {meta.url && <meta property="og:url" content={meta.url} />}
81
- {meta.siteName && <meta property="og:site_name" content={meta.siteName} />}
82
- {meta.title && <meta property="og:title" content={meta.title} />}
83
- {meta.description && (<meta property="og:description" content={meta.description} />)}
84
- {meta.image && <meta property="og:image" content={abs(meta.image)} />}
85
- {meta.locale && <meta property="og:locale" content={meta.locale} />}
86
- <meta name="twitter:card" content={meta.twitterX?.card ?? "summary_large_image"} />
87
- {meta.twitterX?.site && (<meta name="twitter:site" content={meta.twitterX.site} />)}
88
- {meta.twitterX?.creator && (<meta name="twitter:creator" content={meta.twitterX.creator} />)}
89
- {meta.image && (<meta name="twitter:image" content={abs(meta.image)} />)}
90
- {meta.twitterX?.imageAlt && (<meta name="twitter:image:alt" content={meta.twitterX.imageAlt} />)}
91
- </Head>
92
- <SkipToContent />
93
- <AnnouncementBar />
94
- <Navbar />
95
- {starProps.repoUrl && starProps.label && <StarUs {...starProps} />}
96
- <div
97
- className={clsx(
98
- ThemeClassNames.wrapper.main,
99
- styles.ozLayoutMainWrapper,
100
- className,
101
- )}
102
- >
103
- <ErrorBoundary fallback={<ErrorPageContent />}>
104
- {children}
105
- </ErrorBoundary>
106
- {!noFooter && footerProps && <NetFoundryFooter {...footerProps} />}
107
- </div>
108
- </LayoutProvider>
109
- );
110
- }
@@ -1 +0,0 @@
1
- export * from './NetFoundryLayout';
@@ -1,2 +0,0 @@
1
- export type {NavbarItem} from './NetFoundryNavbarItems';
2
- export { NavbarItems } from './NetFoundryNavbarItems';