ardo 3.1.0 → 3.2.1

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 (123) hide show
  1. package/README.md +9 -19
  2. package/dist/DocPage-CIBiCAxZ.js +1010 -0
  3. package/dist/DocPage-CIBiCAxZ.js.map +1 -0
  4. package/dist/assets/src/ui/Breadcrumb.css.ts.vanilla-Dpgq-C_p.css +20 -0
  5. package/dist/assets/src/ui/DocPage.css.ts.vanilla-CXKuz4U-.css +34 -0
  6. package/dist/assets/src/ui/Footer.css.ts.vanilla-BSzPIPt4.css +100 -0
  7. package/dist/assets/src/ui/Header.css.ts.vanilla-8QL0Jzgk.css +156 -0
  8. package/dist/assets/src/ui/Layout.css.ts.vanilla-Bpx_-gJt.css +67 -0
  9. package/dist/assets/src/ui/Nav.css.ts.vanilla-CsAQjogy.css +51 -0
  10. package/dist/assets/src/ui/Sidebar.css.ts.vanilla-D70qXTEr.css +115 -0
  11. package/dist/assets/src/ui/Toc.css.ts.vanilla-CYqcWgvD.css +52 -0
  12. package/dist/assets/src/ui/components/ApiItem.css.ts.vanilla-B_DW-1iJ.css +218 -0
  13. package/dist/assets/src/ui/components/CodeBlock.css.ts.vanilla-lNKqskjQ.css +182 -0
  14. package/dist/assets/src/ui/components/Container.css.ts.vanilla-CUhRUA9t.css +80 -0
  15. package/dist/assets/src/ui/components/CopyButton.css.ts.vanilla-DZZ5jgTM.css +24 -0
  16. package/dist/assets/src/ui/components/Features.css.ts.vanilla-D-pNXM9Q.css +129 -0
  17. package/dist/assets/src/ui/components/Hero.css.ts.vanilla-DHJVZ6GX.css +134 -0
  18. package/dist/assets/src/ui/components/Search.css.ts.vanilla-BYpWHzky.css +135 -0
  19. package/dist/assets/src/ui/components/Steps.css.ts.vanilla-CisaxeNj.css +59 -0
  20. package/dist/assets/src/ui/components/Tabs.css.ts.vanilla-C4-vJSnf.css +30 -0
  21. package/dist/assets/src/ui/components/ThemeToggle.css.ts.vanilla---sSUELC.css +22 -0
  22. package/dist/assets/src/ui/content.css.ts.vanilla-O_RaSPXm.css +106 -0
  23. package/dist/assets/src/ui/theme/animations.css.ts.vanilla-D6ImVUKy.css +10 -0
  24. package/dist/assets/src/ui/theme/dark.css.ts.vanilla-2iJgcpbU.css +87 -0
  25. package/dist/assets/src/ui/theme/light.css.ts.vanilla-CwinfWSf.css +87 -0
  26. package/dist/assets/src/ui/theme/reset.css.ts.vanilla-0Q3pLjfC.css +34 -0
  27. package/dist/brand-icons-DLJKqTun.js +59 -0
  28. package/dist/brand-icons-DLJKqTun.js.map +1 -0
  29. package/dist/config/index.d.ts +5 -5
  30. package/dist/config/index.d.ts.map +1 -0
  31. package/dist/config/index.js +54 -11
  32. package/dist/config/index.js.map +1 -1
  33. package/dist/contract.css-DYvFVCFE.d.ts +105 -0
  34. package/dist/contract.css-DYvFVCFE.d.ts.map +1 -0
  35. package/dist/generator-DPtRXxM_.js +1194 -0
  36. package/dist/generator-DPtRXxM_.js.map +1 -0
  37. package/dist/icons/index.d.ts +22 -1
  38. package/dist/icons/index.d.ts.map +1 -0
  39. package/dist/icons/index.js +2 -2
  40. package/dist/index-BTeHvysI.d.ts +807 -0
  41. package/dist/index-BTeHvysI.d.ts.map +1 -0
  42. package/dist/index-DySzkJlC.d.ts +78 -0
  43. package/dist/index-DySzkJlC.d.ts.map +1 -0
  44. package/dist/index.d.ts +5 -8
  45. package/dist/index.js +6 -100
  46. package/dist/mdx/provider.d.ts +61 -4
  47. package/dist/mdx/provider.d.ts.map +1 -0
  48. package/dist/mdx/provider.js +89 -117
  49. package/dist/mdx/provider.js.map +1 -1
  50. package/dist/runtime/index.d.ts +2 -41
  51. package/dist/runtime/index.js +2 -28
  52. package/dist/sidebar-utils-1Skqle1Q.js +109 -0
  53. package/dist/sidebar-utils-1Skqle1Q.js.map +1 -0
  54. package/dist/theme/index.d.ts +201 -182
  55. package/dist/theme/index.d.ts.map +1 -0
  56. package/dist/theme/index.js +288 -128
  57. package/dist/theme/index.js.map +1 -1
  58. package/dist/typedoc/components/index.d.ts +55 -0
  59. package/dist/typedoc/components/index.d.ts.map +1 -0
  60. package/dist/typedoc/components/index.js +339 -0
  61. package/dist/typedoc/components/index.js.map +1 -0
  62. package/dist/typedoc/index.d.ts +36 -305
  63. package/dist/typedoc/index.d.ts.map +1 -0
  64. package/dist/typedoc/index.js +97 -268
  65. package/dist/typedoc/index.js.map +1 -1
  66. package/dist/types-BCuJBsJu.d.ts +182 -0
  67. package/dist/types-BCuJBsJu.d.ts.map +1 -0
  68. package/dist/types-CTd_mkrv.d.ts +175 -0
  69. package/dist/types-CTd_mkrv.d.ts.map +1 -0
  70. package/dist/ui/index.d.ts +2 -178
  71. package/dist/ui/index.js +3 -95
  72. package/dist/ui/styles.css +1401 -1335
  73. package/dist/ui/styles.d.ts +1 -2
  74. package/dist/ui/styles.js +23 -4
  75. package/dist/ui-3grzJSsq.js +1314 -0
  76. package/dist/ui-3grzJSsq.js.map +1 -0
  77. package/dist/vite/index.d.ts +78 -86
  78. package/dist/vite/index.d.ts.map +1 -0
  79. package/dist/vite/index.js +2931 -1282
  80. package/dist/vite/index.js.map +1 -1
  81. package/package.json +30 -19
  82. package/dist/Features-D_Pt7zpA.d.ts +0 -615
  83. package/dist/Search-DOJMNI2T.css +0 -193
  84. package/dist/Search-DOJMNI2T.css.map +0 -1
  85. package/dist/Search-VYYG3D43.js +0 -10
  86. package/dist/Search-VYYG3D43.js.map +0 -1
  87. package/dist/chunk-4YQE3TNM.js +0 -1
  88. package/dist/chunk-4YQE3TNM.js.map +0 -1
  89. package/dist/chunk-AXLJDGQL.js +0 -1
  90. package/dist/chunk-AXLJDGQL.js.map +0 -1
  91. package/dist/chunk-CZM5NX27.js +0 -909
  92. package/dist/chunk-CZM5NX27.js.map +0 -1
  93. package/dist/chunk-FZP2AVJL.js +0 -43
  94. package/dist/chunk-FZP2AVJL.js.map +0 -1
  95. package/dist/chunk-IEPSORG5.js +0 -444
  96. package/dist/chunk-IEPSORG5.js.map +0 -1
  97. package/dist/chunk-KUWEUO37.js +0 -1
  98. package/dist/chunk-KUWEUO37.js.map +0 -1
  99. package/dist/chunk-NBRHGTR2.js +0 -79
  100. package/dist/chunk-NBRHGTR2.js.map +0 -1
  101. package/dist/chunk-PGHUPTGL.js +0 -1035
  102. package/dist/chunk-PGHUPTGL.js.map +0 -1
  103. package/dist/chunk-PMS3P4MA.js +0 -43
  104. package/dist/chunk-PMS3P4MA.js.map +0 -1
  105. package/dist/chunk-QELSOHIY.js +0 -46
  106. package/dist/chunk-QELSOHIY.js.map +0 -1
  107. package/dist/chunk-R2QKY6G3.js +0 -1
  108. package/dist/chunk-R2QKY6G3.js.map +0 -1
  109. package/dist/chunk-ZPYQQZ7J.js +0 -210
  110. package/dist/chunk-ZPYQQZ7J.js.map +0 -1
  111. package/dist/icons/index.js.map +0 -1
  112. package/dist/index.css +0 -1290
  113. package/dist/index.css.map +0 -1
  114. package/dist/index.js.map +0 -1
  115. package/dist/mdx/provider.css +0 -403
  116. package/dist/mdx/provider.css.map +0 -1
  117. package/dist/runtime/index.js.map +0 -1
  118. package/dist/types-CLkHwCch.d.ts +0 -248
  119. package/dist/ui/index.css +0 -1290
  120. package/dist/ui/index.css.map +0 -1
  121. package/dist/ui/index.js.map +0 -1
  122. package/dist/ui/styles.css.map +0 -1
  123. package/dist/ui/styles.js.map +0 -1
@@ -1,248 +0,0 @@
1
- import { BundledTheme } from 'shiki';
2
-
3
- interface SidebarItem {
4
- text: string;
5
- link?: string;
6
- collapsed?: boolean;
7
- items?: SidebarItem[];
8
- }
9
- interface NavItem {
10
- text: string;
11
- link?: string;
12
- items?: NavItem[];
13
- activeMatch?: string;
14
- }
15
- interface SponsorConfig {
16
- text: string;
17
- link: string;
18
- }
19
- interface SocialLink {
20
- icon: "github" | "twitter" | "discord" | "linkedin" | "youtube" | "npm";
21
- link: string;
22
- ariaLabel?: string;
23
- }
24
- /**
25
- * Theme configuration for backwards compatibility with config-driven approach.
26
- * In JSX-first architecture, most of these settings are passed directly
27
- * as props to the components instead.
28
- */
29
- interface ThemeConfig {
30
- /** Logo image URL or light/dark variants */
31
- logo?: string | {
32
- light: string;
33
- dark: string;
34
- };
35
- /** Site title (set to false to hide) */
36
- siteTitle?: string | false;
37
- /** Navigation items (deprecated: use <Nav> component instead) */
38
- nav?: NavItem[];
39
- /** Sidebar configuration (deprecated: use <Sidebar> component instead) */
40
- sidebar?: SidebarItem[] | Record<string, SidebarItem[]>;
41
- /** Social links (deprecated: use <SocialLink> component instead) */
42
- socialLinks?: SocialLink[];
43
- /** Footer configuration (deprecated: use <Footer> component instead) */
44
- footer?: {
45
- message?: string;
46
- copyright?: string;
47
- sponsor?: SponsorConfig;
48
- };
49
- /** Search configuration */
50
- search?: {
51
- enabled?: boolean;
52
- placeholder?: string;
53
- };
54
- /** Edit link configuration */
55
- editLink?: {
56
- pattern: string;
57
- text?: string;
58
- };
59
- /** Last updated configuration */
60
- lastUpdated?: {
61
- enabled?: boolean;
62
- text?: string;
63
- formatOptions?: Intl.DateTimeFormatOptions;
64
- };
65
- /** Table of contents configuration */
66
- outline?: {
67
- level?: number | [number, number];
68
- label?: string;
69
- };
70
- }
71
- interface MarkdownConfig {
72
- /** Syntax highlighting theme */
73
- theme?: BundledTheme | {
74
- light: BundledTheme;
75
- dark: BundledTheme;
76
- };
77
- /** Show line numbers in code blocks */
78
- lineNumbers?: boolean;
79
- /** Enable anchor links for headings */
80
- anchor?: boolean;
81
- /** Table of contents configuration */
82
- toc?: {
83
- level?: [number, number];
84
- };
85
- /** Remark plugins */
86
- remarkPlugins?: unknown[];
87
- /** Rehype plugins */
88
- rehypePlugins?: unknown[];
89
- }
90
- interface HeadConfig {
91
- tag: string;
92
- attrs?: Record<string, string | boolean>;
93
- children?: string;
94
- }
95
- interface TypeDocConfig {
96
- enabled?: boolean;
97
- entryPoints: string[];
98
- tsconfig?: string;
99
- out?: string;
100
- readme?: string | "none";
101
- plugin?: string[];
102
- exclude?: string[];
103
- excludeExternals?: boolean;
104
- excludePrivate?: boolean;
105
- excludeProtected?: boolean;
106
- excludeInternal?: boolean;
107
- sort?: Array<"source-order" | "alphabetical" | "enum-value-ascending" | "enum-value-descending" | "required-first" | "visibility">;
108
- categoryOrder?: string[];
109
- groupOrder?: string[];
110
- watch?: boolean;
111
- sidebar?: {
112
- title?: string;
113
- position?: number;
114
- collapsed?: boolean;
115
- };
116
- markdown?: {
117
- breadcrumbs?: boolean;
118
- hierarchy?: boolean;
119
- sourceLinks?: boolean;
120
- sourceBaseUrl?: string;
121
- codeBlocks?: boolean;
122
- };
123
- }
124
- interface ProjectMeta {
125
- /** Package name from package.json */
126
- name?: string;
127
- /** Homepage URL from package.json */
128
- homepage?: string;
129
- /** Repository URL (resolved from package.json repository field) */
130
- repository?: string;
131
- /** Package version */
132
- version?: string;
133
- /** Package author */
134
- author?: string;
135
- /** Package license */
136
- license?: string;
137
- }
138
- /**
139
- * Main Ardo configuration.
140
- *
141
- * In JSX-first architecture, only build-time options are needed here.
142
- * Runtime UI configuration (header, sidebar, footer) is done in JSX.
143
- */
144
- interface ArdoConfig {
145
- /** Site title (used for default meta tags) */
146
- title: string;
147
- /** Site description (used for default meta tags) */
148
- description?: string;
149
- /** Separator between page title and site title (default: " | ") */
150
- titleSeparator?: string;
151
- /** Base URL path */
152
- base?: string;
153
- /** Content source directory (default: 'content') */
154
- srcDir?: string;
155
- /** Build output directory (default: 'dist') */
156
- outDir?: string;
157
- /** Site language (default: 'en') */
158
- lang?: string;
159
- /** Additional head tags (deprecated: use React Router Meta instead) */
160
- head?: HeadConfig[];
161
- /**
162
- * Theme configuration for backwards compatibility.
163
- * Prefer using JSX components with props instead.
164
- */
165
- themeConfig?: ThemeConfig;
166
- /** Markdown processing options */
167
- markdown?: MarkdownConfig;
168
- /**
169
- * TypeDoc API documentation generation.
170
- * - `true`: Enable with defaults (./src/index.ts → content/api-reference/)
171
- * - `{ ... }`: Enable with custom config
172
- */
173
- typedoc?: true | TypeDocConfig;
174
- /** Custom Vite configuration */
175
- vite?: Record<string, unknown>;
176
- /**
177
- * Project metadata (auto-detected from package.json if not provided).
178
- * Available at runtime via `config.project` from `virtual:ardo/config`.
179
- */
180
- project?: ProjectMeta;
181
- /** Build timestamp (ISO string, set automatically by the Vite plugin) */
182
- buildTime?: string;
183
- /** Git commit hash (set automatically by the Vite plugin) */
184
- buildHash?: string;
185
- }
186
- interface PageFrontmatter {
187
- title?: string;
188
- description?: string;
189
- layout?: "doc" | "home" | "page";
190
- sidebar?: boolean;
191
- outline?: boolean | number | [number, number];
192
- editLink?: boolean;
193
- lastUpdated?: boolean;
194
- prev?: string | {
195
- text: string;
196
- link: string;
197
- } | false;
198
- next?: string | {
199
- text: string;
200
- link: string;
201
- } | false;
202
- hero?: {
203
- name?: string;
204
- text?: string;
205
- tagline?: string;
206
- image?: string | {
207
- light: string;
208
- dark: string;
209
- };
210
- actions?: Array<{
211
- text: string;
212
- link: string;
213
- theme?: "brand" | "alt";
214
- }>;
215
- };
216
- features?: Array<{
217
- icon?: string;
218
- title: string;
219
- details: string;
220
- link?: string;
221
- linkText?: string;
222
- }>;
223
- }
224
- interface TOCItem {
225
- id: string;
226
- text: string;
227
- level: number;
228
- children?: TOCItem[];
229
- }
230
- interface PageData {
231
- title: string;
232
- description?: string;
233
- frontmatter: PageFrontmatter;
234
- content: string;
235
- toc: TOCItem[];
236
- lastUpdated?: number;
237
- filePath: string;
238
- relativePath: string;
239
- }
240
- interface ResolvedConfig extends Required<Omit<ArdoConfig, "vite" | "typedoc" | "project" | "buildTime" | "buildHash">> {
241
- project: ProjectMeta;
242
- vite?: Record<string, unknown>;
243
- typedoc?: TypeDocConfig;
244
- root: string;
245
- contentDir: string;
246
- }
247
-
248
- export type { ArdoConfig as A, HeadConfig as H, MarkdownConfig as M, NavItem as N, PageData as P, ResolvedConfig as R, SidebarItem as S, TOCItem as T, PageFrontmatter as a, ProjectMeta as b, SocialLink as c, ThemeConfig as d, TypeDocConfig as e, SponsorConfig as f };