boltdocs 1.5.0 → 1.7.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 (57) hide show
  1. package/dist/{PackageManagerTabs-XW3AVXVX.mjs → PackageManagerTabs-NVT7G625.mjs} +1 -1
  2. package/dist/{SearchDialog-CEVPEMT3.css → SearchDialog-UOAW6IR3.css} +361 -113
  3. package/dist/{SearchDialog-5ISK64QY.mjs → SearchDialog-YOXMFGH6.mjs} +1 -1
  4. package/dist/{chunk-S5G55FBI.mjs → chunk-7SFUJWTB.mjs} +4 -4
  5. package/dist/{chunk-FMQ4HRKZ.mjs → chunk-MULKZFVN.mjs} +873 -759
  6. package/dist/client/index.css +361 -113
  7. package/dist/client/index.d.mts +39 -8
  8. package/dist/client/index.d.ts +39 -8
  9. package/dist/client/index.js +722 -467
  10. package/dist/client/index.mjs +197 -58
  11. package/dist/client/ssr.css +361 -113
  12. package/dist/client/ssr.d.mts +3 -1
  13. package/dist/client/ssr.d.ts +3 -1
  14. package/dist/client/ssr.js +533 -412
  15. package/dist/client/ssr.mjs +3 -2
  16. package/dist/{config-DkZg5aCf.d.ts → config-D68h41CA.d.mts} +21 -2
  17. package/dist/{config-DkZg5aCf.d.mts → config-D68h41CA.d.ts} +21 -2
  18. package/dist/node/index.d.mts +10 -2
  19. package/dist/node/index.d.ts +10 -2
  20. package/dist/node/index.js +45 -21
  21. package/dist/node/index.mjs +45 -21
  22. package/dist/{types-DGIo1VKD.d.ts → types-CviV0GbX.d.mts} +13 -0
  23. package/dist/{types-DGIo1VKD.d.mts → types-CviV0GbX.d.ts} +13 -0
  24. package/package.json +1 -1
  25. package/src/client/app/index.tsx +8 -4
  26. package/src/client/index.ts +4 -0
  27. package/src/client/ssr.tsx +4 -1
  28. package/src/client/theme/components/mdx/FileTree.tsx +229 -0
  29. package/src/client/theme/components/mdx/Table.tsx +53 -0
  30. package/src/client/theme/components/mdx/Tabs.tsx +1 -4
  31. package/src/client/theme/components/mdx/index.ts +6 -0
  32. package/src/client/theme/components/mdx/mdx-components.css +158 -0
  33. package/src/client/theme/icons/pnpm.tsx +5 -5
  34. package/src/client/theme/styles/markdown.css +8 -3
  35. package/src/client/theme/styles/variables.css +10 -9
  36. package/src/client/theme/ui/Layout/Layout.tsx +2 -10
  37. package/src/client/theme/ui/Layout/base.css +15 -3
  38. package/src/client/theme/ui/Link/Link.tsx +2 -2
  39. package/src/client/theme/ui/Link/LinkPreview.tsx +9 -14
  40. package/src/client/theme/ui/Link/link-preview.css +30 -27
  41. package/src/client/theme/ui/Navbar/Navbar.tsx +65 -17
  42. package/src/client/theme/ui/Navbar/Tabs.tsx +74 -0
  43. package/src/client/theme/ui/Navbar/navbar.css +111 -5
  44. package/src/client/theme/ui/OnThisPage/OnThisPage.tsx +65 -49
  45. package/src/client/theme/ui/OnThisPage/toc.css +30 -10
  46. package/src/client/theme/ui/Sidebar/Sidebar.tsx +97 -57
  47. package/src/client/theme/ui/Sidebar/sidebar.css +61 -67
  48. package/src/client/types.ts +10 -0
  49. package/src/node/config.ts +19 -1
  50. package/src/node/plugin/entry.ts +5 -1
  51. package/src/node/plugin/index.ts +2 -1
  52. package/src/node/routes/index.ts +12 -1
  53. package/src/node/routes/parser.ts +21 -7
  54. package/src/node/routes/types.ts +9 -1
  55. package/src/node/ssg/index.ts +2 -1
  56. package/src/node/ssg/options.ts +2 -0
  57. package/src/client/theme/icons/yarn.tsx +0 -16
@@ -1,6 +1,6 @@
1
- import { B as BoltdocsConfig } from '../config-DkZg5aCf.mjs';
2
- export { a as BoltdocsThemeConfig } from '../config-DkZg5aCf.mjs';
3
- import { C as CreateBoltdocsAppOptions, a as ComponentRoute } from '../types-DGIo1VKD.mjs';
1
+ import { B as BoltdocsConfig } from '../config-D68h41CA.mjs';
2
+ export { a as BoltdocsThemeConfig } from '../config-D68h41CA.mjs';
3
+ import { C as CreateBoltdocsAppOptions, a as ComponentRoute } from '../types-CviV0GbX.mjs';
4
4
  import * as react_jsx_runtime from 'react/jsx-runtime';
5
5
  import React from 'react';
6
6
  import 'vite';
@@ -54,6 +54,9 @@ interface RouteItem {
54
54
  text: string;
55
55
  expires?: string;
56
56
  };
57
+ icon?: string;
58
+ tab?: string;
59
+ groupIcon?: string;
57
60
  }
58
61
  /**
59
62
  * The sidebar navigation component.
@@ -63,11 +66,9 @@ interface RouteItem {
63
66
  * @param routes - Array of all generated routes to be displayed
64
67
  * @param config - Global configuration (which can contain sidebar overrides)
65
68
  */
66
- declare function Sidebar({ routes, config, isCollapsed, onToggle, }: {
69
+ declare function Sidebar({ routes, config, }: {
67
70
  routes: RouteItem[];
68
71
  config: BoltdocsConfig;
69
- isCollapsed?: boolean;
70
- onToggle?: () => void;
71
72
  }): react_jsx_runtime.JSX.Element;
72
73
 
73
74
  interface TocHeading {
@@ -279,7 +280,6 @@ interface TabsProps {
279
280
  * <Tabs>
280
281
  * <Tab label="npm">npm install boltdocs</Tab>
281
282
  * <Tab label="pnpm">pnpm add boltdocs</Tab>
282
- * <Tab label="yarn">yarn add boltdocs</Tab>
283
283
  * </Tabs>
284
284
  * ```
285
285
  */
@@ -326,4 +326,35 @@ interface ListProps extends React.HTMLAttributes<HTMLUListElement> {
326
326
  */
327
327
  declare function List({ variant, children, className, ...rest }: ListProps): react_jsx_runtime.JSX.Element;
328
328
 
329
- export { Admonition, type AdmonitionProps, BackgroundGradient, Badge, type BadgeProps, BoltdocsConfig, Breadcrumbs, Button, type ButtonProps, Card, type CardProps, Cards, type CardsProps, CodeBlock, ComponentRoute, CreateBoltdocsAppOptions, Danger, Head, InfoBox, List, type ListProps, Loading, Navbar, NotFound, Note, OnThisPage, Playground, Sidebar, Tab, type TabProps, Tabs, type TabsProps, ThemeLayout, Tip, Video, Warning, createBoltdocsApp };
329
+ interface FileTreeProps {
330
+ children: React.ReactNode;
331
+ }
332
+ /**
333
+ * FileTree component displays a customized, styled tree structure for markdown lists.
334
+ *
335
+ * ```mdx
336
+ * <FileTree>
337
+ * - src/
338
+ * - index.ts
339
+ * - components/
340
+ * - Button.tsx
341
+ * - package.json
342
+ * </FileTree>
343
+ * ```
344
+ */
345
+ declare function FileTree({ children }: FileTreeProps): react_jsx_runtime.JSX.Element;
346
+
347
+ interface TableProps {
348
+ headers?: string[];
349
+ data?: (string | React.ReactNode)[][];
350
+ children?: React.ReactNode;
351
+ className?: string;
352
+ }
353
+ /**
354
+ * A consistent, themed table component for documentation.
355
+ * Can be used by passing structured 'headers' and 'data' props,
356
+ * or by wrapping standard <thead>/<tbody> elements.
357
+ */
358
+ declare function Table({ headers, data, children, className, }: TableProps): react_jsx_runtime.JSX.Element;
359
+
360
+ export { Admonition, type AdmonitionProps, BackgroundGradient, Badge, type BadgeProps, BoltdocsConfig, Breadcrumbs, Button, type ButtonProps, Card, type CardProps, Cards, type CardsProps, CodeBlock, ComponentRoute, CreateBoltdocsAppOptions, Danger, FileTree, type FileTreeProps, Head, InfoBox, List, type ListProps, Loading, Navbar, NotFound, Note, OnThisPage, Playground, Sidebar, Tab, type TabProps, Table, type TableProps, Tabs, type TabsProps, ThemeLayout, Tip, Video, Warning, createBoltdocsApp };
@@ -1,6 +1,6 @@
1
- import { B as BoltdocsConfig } from '../config-DkZg5aCf.js';
2
- export { a as BoltdocsThemeConfig } from '../config-DkZg5aCf.js';
3
- import { C as CreateBoltdocsAppOptions, a as ComponentRoute } from '../types-DGIo1VKD.js';
1
+ import { B as BoltdocsConfig } from '../config-D68h41CA.js';
2
+ export { a as BoltdocsThemeConfig } from '../config-D68h41CA.js';
3
+ import { C as CreateBoltdocsAppOptions, a as ComponentRoute } from '../types-CviV0GbX.js';
4
4
  import * as react_jsx_runtime from 'react/jsx-runtime';
5
5
  import React from 'react';
6
6
  import 'vite';
@@ -54,6 +54,9 @@ interface RouteItem {
54
54
  text: string;
55
55
  expires?: string;
56
56
  };
57
+ icon?: string;
58
+ tab?: string;
59
+ groupIcon?: string;
57
60
  }
58
61
  /**
59
62
  * The sidebar navigation component.
@@ -63,11 +66,9 @@ interface RouteItem {
63
66
  * @param routes - Array of all generated routes to be displayed
64
67
  * @param config - Global configuration (which can contain sidebar overrides)
65
68
  */
66
- declare function Sidebar({ routes, config, isCollapsed, onToggle, }: {
69
+ declare function Sidebar({ routes, config, }: {
67
70
  routes: RouteItem[];
68
71
  config: BoltdocsConfig;
69
- isCollapsed?: boolean;
70
- onToggle?: () => void;
71
72
  }): react_jsx_runtime.JSX.Element;
72
73
 
73
74
  interface TocHeading {
@@ -279,7 +280,6 @@ interface TabsProps {
279
280
  * <Tabs>
280
281
  * <Tab label="npm">npm install boltdocs</Tab>
281
282
  * <Tab label="pnpm">pnpm add boltdocs</Tab>
282
- * <Tab label="yarn">yarn add boltdocs</Tab>
283
283
  * </Tabs>
284
284
  * ```
285
285
  */
@@ -326,4 +326,35 @@ interface ListProps extends React.HTMLAttributes<HTMLUListElement> {
326
326
  */
327
327
  declare function List({ variant, children, className, ...rest }: ListProps): react_jsx_runtime.JSX.Element;
328
328
 
329
- export { Admonition, type AdmonitionProps, BackgroundGradient, Badge, type BadgeProps, BoltdocsConfig, Breadcrumbs, Button, type ButtonProps, Card, type CardProps, Cards, type CardsProps, CodeBlock, ComponentRoute, CreateBoltdocsAppOptions, Danger, Head, InfoBox, List, type ListProps, Loading, Navbar, NotFound, Note, OnThisPage, Playground, Sidebar, Tab, type TabProps, Tabs, type TabsProps, ThemeLayout, Tip, Video, Warning, createBoltdocsApp };
329
+ interface FileTreeProps {
330
+ children: React.ReactNode;
331
+ }
332
+ /**
333
+ * FileTree component displays a customized, styled tree structure for markdown lists.
334
+ *
335
+ * ```mdx
336
+ * <FileTree>
337
+ * - src/
338
+ * - index.ts
339
+ * - components/
340
+ * - Button.tsx
341
+ * - package.json
342
+ * </FileTree>
343
+ * ```
344
+ */
345
+ declare function FileTree({ children }: FileTreeProps): react_jsx_runtime.JSX.Element;
346
+
347
+ interface TableProps {
348
+ headers?: string[];
349
+ data?: (string | React.ReactNode)[][];
350
+ children?: React.ReactNode;
351
+ className?: string;
352
+ }
353
+ /**
354
+ * A consistent, themed table component for documentation.
355
+ * Can be used by passing structured 'headers' and 'data' props,
356
+ * or by wrapping standard <thead>/<tbody> elements.
357
+ */
358
+ declare function Table({ headers, data, children, className, }: TableProps): react_jsx_runtime.JSX.Element;
359
+
360
+ export { Admonition, type AdmonitionProps, BackgroundGradient, Badge, type BadgeProps, BoltdocsConfig, Breadcrumbs, Button, type ButtonProps, Card, type CardProps, Cards, type CardsProps, CodeBlock, ComponentRoute, CreateBoltdocsAppOptions, Danger, FileTree, type FileTreeProps, Head, InfoBox, List, type ListProps, Loading, Navbar, NotFound, Note, OnThisPage, Playground, Sidebar, Tab, type TabProps, Table, type TableProps, Tabs, type TabsProps, ThemeLayout, Tip, Video, Warning, createBoltdocsApp };