@netfoundry/docusaurus-theme 0.1.2 → 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 (200) hide show
  1. package/README.md +146 -0
  2. package/css/legacy.css +4 -3
  3. package/dist/src/components/Alert/Alert.d.ts +9 -0
  4. package/dist/src/components/Alert/Alert.d.ts.map +1 -0
  5. package/dist/src/components/Alert/Alert.js +7 -0
  6. package/dist/src/components/Alert/Alert.js.map +1 -0
  7. package/{src/components/Alert/index.ts → dist/src/components/Alert/index.d.ts} +1 -0
  8. package/dist/src/components/Alert/index.d.ts.map +1 -0
  9. package/dist/src/components/Alert/index.js +2 -0
  10. package/dist/src/components/Alert/index.js.map +1 -0
  11. package/dist/src/components/CodeBlock/CodeBlock.d.ts +10 -0
  12. package/dist/src/components/CodeBlock/CodeBlock.d.ts.map +1 -0
  13. package/dist/src/components/CodeBlock/CodeBlock.js +8 -0
  14. package/dist/src/components/CodeBlock/CodeBlock.js.map +1 -0
  15. package/{src/components/CodeBlock/index.ts → dist/src/components/CodeBlock/index.d.ts} +1 -0
  16. package/dist/src/components/CodeBlock/index.d.ts.map +1 -0
  17. package/dist/src/components/CodeBlock/index.js +2 -0
  18. package/dist/src/components/CodeBlock/index.js.map +1 -0
  19. package/dist/src/components/Common/Common.d.ts +24 -0
  20. package/dist/src/components/Common/Common.d.ts.map +1 -0
  21. package/dist/src/components/Common/Common.js +20 -0
  22. package/dist/src/components/Common/Common.js.map +1 -0
  23. package/dist/src/components/Common/index.d.ts +2 -0
  24. package/dist/src/components/Common/index.d.ts.map +1 -0
  25. package/dist/src/components/Common/index.js +2 -0
  26. package/dist/src/components/Common/index.js.map +1 -0
  27. package/dist/src/components/NetFoundry/Divider/Divider.d.ts +3 -0
  28. package/dist/src/components/NetFoundry/Divider/Divider.d.ts.map +1 -0
  29. package/dist/src/components/NetFoundry/Divider/Divider.js +6 -0
  30. package/dist/src/components/NetFoundry/Divider/Divider.js.map +1 -0
  31. package/dist/src/components/NetFoundry/Divider/index.d.ts +2 -0
  32. package/dist/src/components/NetFoundry/Divider/index.d.ts.map +1 -0
  33. package/dist/src/components/NetFoundry/Divider/index.js +2 -0
  34. package/dist/src/components/NetFoundry/Divider/index.js.map +1 -0
  35. package/dist/src/components/NetFoundry/index.d.ts +2 -0
  36. package/dist/src/components/NetFoundry/index.d.ts.map +1 -0
  37. package/dist/src/components/NetFoundry/index.js +2 -0
  38. package/dist/src/components/NetFoundry/index.js.map +1 -0
  39. package/dist/src/components/NetFoundryFooter/NetFoundryFooter.d.ts +23 -0
  40. package/dist/src/components/NetFoundryFooter/NetFoundryFooter.d.ts.map +1 -0
  41. package/dist/src/components/NetFoundryFooter/NetFoundryFooter.js +63 -0
  42. package/dist/src/components/NetFoundryFooter/NetFoundryFooter.js.map +1 -0
  43. package/dist/src/components/NetFoundryFooter/index.d.ts +2 -0
  44. package/dist/src/components/NetFoundryFooter/index.d.ts.map +1 -0
  45. package/{src/components/NetFoundryFooter/index.ts → dist/src/components/NetFoundryFooter/index.js} +2 -1
  46. package/dist/src/components/NetFoundryFooter/index.js.map +1 -0
  47. package/dist/src/components/NetFoundryHighlight/NetFoundryHighlight.d.ts +7 -0
  48. package/dist/src/components/NetFoundryHighlight/NetFoundryHighlight.d.ts.map +1 -0
  49. package/dist/src/components/NetFoundryHighlight/NetFoundryHighlight.js +6 -0
  50. package/dist/src/components/NetFoundryHighlight/NetFoundryHighlight.js.map +1 -0
  51. package/{src/components/NetFoundryHighlight/index.ts → dist/src/components/NetFoundryHighlight/index.d.ts} +3 -2
  52. package/dist/src/components/NetFoundryHighlight/index.d.ts.map +1 -0
  53. package/dist/src/components/NetFoundryHighlight/index.js +2 -0
  54. package/dist/src/components/NetFoundryHighlight/index.js.map +1 -0
  55. package/dist/src/components/NetFoundryHorizontalSection/NetFoundryHorizontalSection.d.ts +9 -0
  56. package/dist/src/components/NetFoundryHorizontalSection/NetFoundryHorizontalSection.d.ts.map +1 -0
  57. package/dist/src/components/NetFoundryHorizontalSection/NetFoundryHorizontalSection.js +8 -0
  58. package/dist/src/components/NetFoundryHorizontalSection/NetFoundryHorizontalSection.js.map +1 -0
  59. package/dist/src/components/NetFoundryHorizontalSection/index.d.ts +3 -0
  60. package/dist/src/components/NetFoundryHorizontalSection/index.d.ts.map +1 -0
  61. package/dist/src/components/NetFoundryHorizontalSection/index.js +2 -0
  62. package/dist/src/components/NetFoundryHorizontalSection/index.js.map +1 -0
  63. package/dist/src/components/NetFoundryLayout/NetFoundryLayout.d.ts +30 -0
  64. package/dist/src/components/NetFoundryLayout/NetFoundryLayout.d.ts.map +1 -0
  65. package/dist/src/components/NetFoundryLayout/NetFoundryLayout.js +35 -0
  66. package/dist/src/components/NetFoundryLayout/NetFoundryLayout.js.map +1 -0
  67. package/dist/src/components/NetFoundryLayout/index.d.ts +2 -0
  68. package/dist/src/components/NetFoundryLayout/index.d.ts.map +1 -0
  69. package/dist/src/components/NetFoundryLayout/index.js +2 -0
  70. package/dist/src/components/NetFoundryLayout/index.js.map +1 -0
  71. package/dist/src/components/NetFoundryNavbarItems/NetFoundryNavbarItems.d.ts +10 -0
  72. package/dist/src/components/NetFoundryNavbarItems/NetFoundryNavbarItems.d.ts.map +1 -0
  73. package/{src/components/NetFoundryNavbarItems/NetFoundryNavbarItems.tsx → dist/src/components/NetFoundryNavbarItems/NetFoundryNavbarItems.js} +14 -22
  74. package/dist/src/components/NetFoundryNavbarItems/NetFoundryNavbarItems.js.map +1 -0
  75. package/dist/src/components/NetFoundryNavbarItems/index.d.ts +3 -0
  76. package/dist/src/components/NetFoundryNavbarItems/index.d.ts.map +1 -0
  77. package/dist/src/components/NetFoundryNavbarItems/index.js +2 -0
  78. package/dist/src/components/NetFoundryNavbarItems/index.js.map +1 -0
  79. package/dist/src/components/OsTabs/OsTabs.d.ts +6 -0
  80. package/dist/src/components/OsTabs/OsTabs.d.ts.map +1 -0
  81. package/dist/src/components/OsTabs/OsTabs.js +18 -0
  82. package/dist/src/components/OsTabs/OsTabs.js.map +1 -0
  83. package/dist/src/components/OsTabs/index.d.ts +3 -0
  84. package/dist/src/components/OsTabs/index.d.ts.map +1 -0
  85. package/dist/src/components/OsTabs/index.js +2 -0
  86. package/dist/src/components/OsTabs/index.js.map +1 -0
  87. package/dist/src/components/StarUs/StarUs.d.ts +7 -0
  88. package/dist/src/components/StarUs/StarUs.d.ts.map +1 -0
  89. package/dist/src/components/StarUs/StarUs.js +7 -0
  90. package/dist/src/components/StarUs/StarUs.js.map +1 -0
  91. package/dist/src/components/StarUs/index.d.ts +3 -0
  92. package/dist/src/components/StarUs/index.d.ts.map +1 -0
  93. package/{src/components/StarUs/index.ts → dist/src/components/StarUs/index.js} +1 -1
  94. package/dist/src/components/StarUs/index.js.map +1 -0
  95. package/dist/src/components/index.d.ts +12 -0
  96. package/dist/src/components/index.d.ts.map +1 -0
  97. package/{src/components/index.ts → dist/src/components/index.js} +3 -2
  98. package/dist/src/components/index.js.map +1 -0
  99. package/dist/src/docusaurus-envhelper.d.ts +16 -0
  100. package/dist/src/docusaurus-envhelper.d.ts.map +1 -0
  101. package/{src/docusaurus-envhelper.ts → dist/src/docusaurus-envhelper.js} +66 -98
  102. package/dist/src/docusaurus-envhelper.js.map +1 -0
  103. package/dist/src/docusaurus-plugins/index.d.ts +8 -0
  104. package/dist/src/docusaurus-plugins/index.d.ts.map +1 -0
  105. package/dist/src/docusaurus-plugins/index.js +8 -0
  106. package/dist/src/docusaurus-plugins/index.js.map +1 -0
  107. package/dist/src/docusaurus-plugins/logger.d.ts +13 -0
  108. package/dist/src/docusaurus-plugins/logger.d.ts.map +1 -0
  109. package/dist/src/docusaurus-plugins/logger.js +41 -0
  110. package/dist/src/docusaurus-plugins/logger.js.map +1 -0
  111. package/dist/src/docusaurus-plugins/remarkCodeSections.d.ts +8 -0
  112. package/dist/src/docusaurus-plugins/remarkCodeSections.d.ts.map +1 -0
  113. package/dist/src/docusaurus-plugins/remarkCodeSections.js +96 -0
  114. package/dist/src/docusaurus-plugins/remarkCodeSections.js.map +1 -0
  115. package/dist/src/docusaurus-plugins/remarkReplaceMetaUrl.d.ts +11 -0
  116. package/dist/src/docusaurus-plugins/remarkReplaceMetaUrl.d.ts.map +1 -0
  117. package/dist/src/docusaurus-plugins/remarkReplaceMetaUrl.js +23 -0
  118. package/dist/src/docusaurus-plugins/remarkReplaceMetaUrl.js.map +1 -0
  119. package/dist/src/docusaurus-plugins/remarkScopedPath.d.ts +13 -0
  120. package/dist/src/docusaurus-plugins/remarkScopedPath.d.ts.map +1 -0
  121. package/dist/src/docusaurus-plugins/remarkScopedPath.js +48 -0
  122. package/dist/src/docusaurus-plugins/remarkScopedPath.js.map +1 -0
  123. package/dist/src/docusaurus-plugins/remarkYamlTable.d.ts +8 -0
  124. package/dist/src/docusaurus-plugins/remarkYamlTable.d.ts.map +1 -0
  125. package/dist/src/docusaurus-plugins/remarkYamlTable.js +50 -0
  126. package/dist/src/docusaurus-plugins/remarkYamlTable.js.map +1 -0
  127. package/dist/src/docusaurus-plugins/remarkYouTube.d.ts +8 -0
  128. package/dist/src/docusaurus-plugins/remarkYouTube.d.ts.map +1 -0
  129. package/dist/src/docusaurus-plugins/remarkYouTube.js +44 -0
  130. package/dist/src/docusaurus-plugins/remarkYouTube.js.map +1 -0
  131. package/dist/src/docusaurus-plugins/timedPlugin.d.ts +6 -0
  132. package/dist/src/docusaurus-plugins/timedPlugin.d.ts.map +1 -0
  133. package/dist/src/docusaurus-plugins/timedPlugin.js +16 -0
  134. package/dist/src/docusaurus-plugins/timedPlugin.js.map +1 -0
  135. package/dist/src/index.d.ts +5 -0
  136. package/dist/src/index.d.ts.map +1 -0
  137. package/dist/src/index.js +32 -0
  138. package/dist/src/index.js.map +1 -0
  139. package/dist/src/node.d.ts +7 -0
  140. package/dist/src/node.d.ts.map +1 -0
  141. package/{src/node.ts → dist/src/node.js} +7 -6
  142. package/dist/src/node.js.map +1 -0
  143. package/{src/options.ts → dist/src/options.d.ts} +90 -95
  144. package/dist/src/options.d.ts.map +1 -0
  145. package/dist/src/options.js +2 -0
  146. package/dist/src/options.js.map +1 -0
  147. package/dist/src/plugins.d.ts +7 -0
  148. package/dist/src/plugins.d.ts.map +1 -0
  149. package/{src/plugins.ts → dist/src/plugins.js} +7 -6
  150. package/dist/src/plugins.js.map +1 -0
  151. package/dist/src/ui.d.ts +8 -0
  152. package/dist/src/ui.d.ts.map +1 -0
  153. package/{src/ui.ts → dist/src/ui.js} +8 -7
  154. package/dist/src/ui.js.map +1 -0
  155. package/dist/src/version.d.ts +2 -0
  156. package/dist/src/version.d.ts.map +1 -0
  157. package/dist/src/version.js +2 -0
  158. package/dist/src/version.js.map +1 -0
  159. package/dist/theme/Layout/index.d.ts +19 -0
  160. package/dist/theme/Layout/index.d.ts.map +1 -0
  161. package/dist/theme/Layout/index.js +39 -0
  162. package/dist/theme/Layout/index.js.map +1 -0
  163. package/package.json +24 -16
  164. package/src/components/Alert/Alert.tsx +0 -24
  165. package/src/components/CodeBlock/CodeBlock.tsx +0 -32
  166. package/src/components/Common/Common.tsx +0 -53
  167. package/src/components/Common/index.ts +0 -1
  168. package/src/components/NetFoundry/Divider/Divider.tsx +0 -20
  169. package/src/components/NetFoundry/Divider/index.ts +0 -1
  170. package/src/components/NetFoundry/index.ts +0 -1
  171. package/src/components/NetFoundryFooter/NetFoundryFooter.tsx +0 -164
  172. package/src/components/NetFoundryHighlight/NetFoundryHighlight.tsx +0 -15
  173. package/src/components/NetFoundryHorizontalSection/NetFoundryHorizontalSection.tsx +0 -23
  174. package/src/components/NetFoundryHorizontalSection/index.ts +0 -2
  175. package/src/components/NetFoundryLayout/NetFoundryLayout.tsx +0 -110
  176. package/src/components/NetFoundryLayout/index.ts +0 -1
  177. package/src/components/NetFoundryNavbarItems/index.ts +0 -2
  178. package/src/components/OsTabs/OsTabs.tsx +0 -30
  179. package/src/components/OsTabs/index.ts +0 -2
  180. package/src/components/StarUs/StarUs.tsx +0 -19
  181. package/src/docusaurus-plugins/index.ts +0 -7
  182. package/src/docusaurus-plugins/logger.ts +0 -38
  183. package/src/docusaurus-plugins/remarkCodeSections.ts +0 -115
  184. package/src/docusaurus-plugins/remarkReplaceMetaUrl.ts +0 -35
  185. package/src/docusaurus-plugins/remarkScopedPath.ts +0 -70
  186. package/src/docusaurus-plugins/remarkYamlTable.ts +0 -83
  187. package/src/docusaurus-plugins/remarkYouTube.ts +0 -56
  188. package/src/docusaurus-plugins/timedPlugin.ts +0 -22
  189. package/src/index.ts +0 -46
  190. package/src/version.ts +0 -1
  191. package/theme/Layout/index.tsx +0 -74
  192. /package/{src → dist/src}/components/Alert/Alert.module.css +0 -0
  193. /package/{src → dist/src}/components/CodeBlock/CodeBlock.module.css +0 -0
  194. /package/{src → dist/src}/components/Common/Common.module.css +0 -0
  195. /package/{src → dist/src}/components/NetFoundry/Divider/Divider.module.css +0 -0
  196. /package/{src → dist/src}/components/NetFoundryFooter/styles.module.css +0 -0
  197. /package/{src → dist/src}/components/NetFoundryHighlight/styles.module.css +0 -0
  198. /package/{src → dist/src}/components/NetFoundryHorizontalSection/styles.module.css +0 -0
  199. /package/{src → dist/src}/components/NetFoundryLayout/NetFoundryLayout.module.css +0 -0
  200. /package/{src → dist/src}/components/StarUs/styles.module.css +0 -0
@@ -1,95 +1,90 @@
1
- import type { ReactNode } from 'react';
2
-
3
- /**
4
- * Social media link configuration for the footer
5
- */
6
- export interface SocialProps {
7
- githubUrl?: string;
8
- twitterUrl?: string;
9
- linkedInUrl?: string;
10
- youtubeUrl?: string;
11
- facebookUrl?: string;
12
- instagramUrl?: string;
13
- }
14
-
15
- /**
16
- * Footer configuration for the theme
17
- */
18
- export interface FooterConfig {
19
- /** Description text shown in the footer */
20
- description?: string;
21
- /** Social media links */
22
- socialProps?: SocialProps;
23
- /** Documentation section links (as ReactNode for JSX support) */
24
- documentationLinks?: ReactNode[];
25
- /** Community section links */
26
- communityLinks?: ReactNode[];
27
- /** Resources section links */
28
- resourceLinks?: ReactNode[];
29
- }
30
-
31
- /**
32
- * Star banner configuration
33
- */
34
- export interface StarBannerConfig {
35
- /** GitHub repository URL */
36
- repoUrl: string;
37
- /** Label text for the star button */
38
- label: string;
39
- }
40
-
41
- /**
42
- * Options passed to the theme plugin in docusaurus.config.ts
43
- *
44
- * @example
45
- * ```ts
46
- * themes: [
47
- * ['@netfoundry/docusaurus-theme', {
48
- * customCss: require.resolve('./src/css/custom.css'),
49
- * }],
50
- * ],
51
- * ```
52
- */
53
- export interface NetFoundryThemeOptions {
54
- /** Custom CSS file path(s) to include */
55
- customCss?: string | string[];
56
- }
57
-
58
- /**
59
- * Theme configuration in themeConfig.netfoundry
60
- *
61
- * @example
62
- * ```ts
63
- * themeConfig: {
64
- * netfoundry: {
65
- * footer: {
66
- * description: 'My site description',
67
- * socialProps: {
68
- * githubUrl: 'https://github.com/my-org/repo',
69
- * },
70
- * },
71
- * starBanner: {
72
- * repoUrl: 'https://github.com/my-org/repo',
73
- * label: 'Star us on GitHub',
74
- * },
75
- * showStarBanner: true,
76
- * },
77
- * },
78
- * ```
79
- */
80
- export interface NetFoundryThemeConfig {
81
- /** Footer configuration */
82
- footer?: FooterConfig;
83
- /** Star banner configuration */
84
- starBanner?: StarBannerConfig;
85
- /** Whether to show the star banner (default: false) */
86
- showStarBanner?: boolean;
87
- }
88
-
89
- /**
90
- * Extended Docusaurus ThemeConfig with NetFoundry configuration
91
- */
92
- export interface ThemeConfigWithNetFoundry {
93
- netfoundry?: NetFoundryThemeConfig;
94
- [key: string]: unknown;
95
- }
1
+ import type { ReactNode } from 'react';
2
+ /**
3
+ * Social media link configuration for the footer
4
+ */
5
+ export interface SocialProps {
6
+ githubUrl?: string;
7
+ twitterUrl?: string;
8
+ linkedInUrl?: string;
9
+ youtubeUrl?: string;
10
+ facebookUrl?: string;
11
+ instagramUrl?: string;
12
+ }
13
+ /**
14
+ * Footer configuration for the theme
15
+ */
16
+ export interface FooterConfig {
17
+ /** Description text shown in the footer */
18
+ description?: string;
19
+ /** Social media links */
20
+ socialProps?: SocialProps;
21
+ /** Documentation section links (as ReactNode for JSX support) */
22
+ documentationLinks?: ReactNode[];
23
+ /** Community section links */
24
+ communityLinks?: ReactNode[];
25
+ /** Resources section links */
26
+ resourceLinks?: ReactNode[];
27
+ }
28
+ /**
29
+ * Star banner configuration
30
+ */
31
+ export interface StarBannerConfig {
32
+ /** GitHub repository URL */
33
+ repoUrl: string;
34
+ /** Label text for the star button */
35
+ label: string;
36
+ }
37
+ /**
38
+ * Options passed to the theme plugin in docusaurus.config.ts
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * themes: [
43
+ * ['@netfoundry/docusaurus-theme', {
44
+ * customCss: require.resolve('./src/css/custom.css'),
45
+ * }],
46
+ * ],
47
+ * ```
48
+ */
49
+ export interface NetFoundryThemeOptions {
50
+ /** Custom CSS file path(s) to include */
51
+ customCss?: string | string[];
52
+ }
53
+ /**
54
+ * Theme configuration in themeConfig.netfoundry
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * themeConfig: {
59
+ * netfoundry: {
60
+ * footer: {
61
+ * description: 'My site description',
62
+ * socialProps: {
63
+ * githubUrl: 'https://github.com/my-org/repo',
64
+ * },
65
+ * },
66
+ * starBanner: {
67
+ * repoUrl: 'https://github.com/my-org/repo',
68
+ * label: 'Star us on GitHub',
69
+ * },
70
+ * showStarBanner: true,
71
+ * },
72
+ * },
73
+ * ```
74
+ */
75
+ export interface NetFoundryThemeConfig {
76
+ /** Footer configuration */
77
+ footer?: FooterConfig;
78
+ /** Star banner configuration */
79
+ starBanner?: StarBannerConfig;
80
+ /** Whether to show the star banner (default: false) */
81
+ showStarBanner?: boolean;
82
+ }
83
+ /**
84
+ * Extended Docusaurus ThemeConfig with NetFoundry configuration
85
+ */
86
+ export interface ThemeConfigWithNetFoundry {
87
+ netfoundry?: NetFoundryThemeConfig;
88
+ [key: string]: unknown;
89
+ }
90
+ //# sourceMappingURL=options.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yBAAyB;IACzB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,iEAAiE;IACjE,kBAAkB,CAAC,EAAE,SAAS,EAAE,CAAC;IACjC,8BAA8B;IAC9B,cAAc,CAAC,EAAE,SAAS,EAAE,CAAC;IAC7B,8BAA8B;IAC9B,aAAa,CAAC,EAAE,SAAS,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,4BAA4B;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,sBAAsB;IACrC,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,qBAAqB;IACpC,2BAA2B;IAC3B,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,gCAAgC;IAChC,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,uDAAuD;IACvD,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=options.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"options.js","sourceRoot":"","sources":["../../src/options.ts"],"names":[],"mappings":""}
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Remark plugins entry point
3
+ *
4
+ * Import from '@netfoundry/docusaurus-theme/plugins' in docusaurus.config.ts.
5
+ */
6
+ export * from './docusaurus-plugins';
7
+ //# sourceMappingURL=plugins.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"plugins.d.ts","sourceRoot":"","sources":["../../src/plugins.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,cAAc,sBAAsB,CAAC"}
@@ -1,6 +1,7 @@
1
- /**
2
- * Remark plugins entry point
3
- *
4
- * Import from '@netfoundry/docusaurus-theme/plugins' in docusaurus.config.ts.
5
- */
6
- export * from './docusaurus-plugins';
1
+ /**
2
+ * Remark plugins entry point
3
+ *
4
+ * Import from '@netfoundry/docusaurus-theme/plugins' in docusaurus.config.ts.
5
+ */
6
+ export * from './docusaurus-plugins';
7
+ //# sourceMappingURL=plugins.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"plugins.js","sourceRoot":"","sources":["../../src/plugins.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,cAAc,sBAAsB,CAAC"}
@@ -0,0 +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';
8
+ //# sourceMappingURL=ui.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../src/ui.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC"}
@@ -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.2",
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,14 +50,21 @@
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": {
57
65
  "type": "git",
58
66
  "url": "https://github.com/netfoundry/docusaurus-shared.git",
59
- "directory": "lib/packages/docusaurus-theme"
67
+ "directory": "packages/docusaurus-theme"
60
68
  },
61
69
  "keywords": [
62
70
  "docusaurus",
@@ -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'