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.
- package/README.md +9 -19
- package/dist/DocPage-CIBiCAxZ.js +1010 -0
- package/dist/DocPage-CIBiCAxZ.js.map +1 -0
- package/dist/assets/src/ui/Breadcrumb.css.ts.vanilla-Dpgq-C_p.css +20 -0
- package/dist/assets/src/ui/DocPage.css.ts.vanilla-CXKuz4U-.css +34 -0
- package/dist/assets/src/ui/Footer.css.ts.vanilla-BSzPIPt4.css +100 -0
- package/dist/assets/src/ui/Header.css.ts.vanilla-8QL0Jzgk.css +156 -0
- package/dist/assets/src/ui/Layout.css.ts.vanilla-Bpx_-gJt.css +67 -0
- package/dist/assets/src/ui/Nav.css.ts.vanilla-CsAQjogy.css +51 -0
- package/dist/assets/src/ui/Sidebar.css.ts.vanilla-D70qXTEr.css +115 -0
- package/dist/assets/src/ui/Toc.css.ts.vanilla-CYqcWgvD.css +52 -0
- package/dist/assets/src/ui/components/ApiItem.css.ts.vanilla-B_DW-1iJ.css +218 -0
- package/dist/assets/src/ui/components/CodeBlock.css.ts.vanilla-lNKqskjQ.css +182 -0
- package/dist/assets/src/ui/components/Container.css.ts.vanilla-CUhRUA9t.css +80 -0
- package/dist/assets/src/ui/components/CopyButton.css.ts.vanilla-DZZ5jgTM.css +24 -0
- package/dist/assets/src/ui/components/Features.css.ts.vanilla-D-pNXM9Q.css +129 -0
- package/dist/assets/src/ui/components/Hero.css.ts.vanilla-DHJVZ6GX.css +134 -0
- package/dist/assets/src/ui/components/Search.css.ts.vanilla-BYpWHzky.css +135 -0
- package/dist/assets/src/ui/components/Steps.css.ts.vanilla-CisaxeNj.css +59 -0
- package/dist/assets/src/ui/components/Tabs.css.ts.vanilla-C4-vJSnf.css +30 -0
- package/dist/assets/src/ui/components/ThemeToggle.css.ts.vanilla---sSUELC.css +22 -0
- package/dist/assets/src/ui/content.css.ts.vanilla-O_RaSPXm.css +106 -0
- package/dist/assets/src/ui/theme/animations.css.ts.vanilla-D6ImVUKy.css +10 -0
- package/dist/assets/src/ui/theme/dark.css.ts.vanilla-2iJgcpbU.css +87 -0
- package/dist/assets/src/ui/theme/light.css.ts.vanilla-CwinfWSf.css +87 -0
- package/dist/assets/src/ui/theme/reset.css.ts.vanilla-0Q3pLjfC.css +34 -0
- package/dist/brand-icons-DLJKqTun.js +59 -0
- package/dist/brand-icons-DLJKqTun.js.map +1 -0
- package/dist/config/index.d.ts +5 -5
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +54 -11
- package/dist/config/index.js.map +1 -1
- package/dist/contract.css-DYvFVCFE.d.ts +105 -0
- package/dist/contract.css-DYvFVCFE.d.ts.map +1 -0
- package/dist/generator-DPtRXxM_.js +1194 -0
- package/dist/generator-DPtRXxM_.js.map +1 -0
- package/dist/icons/index.d.ts +22 -1
- package/dist/icons/index.d.ts.map +1 -0
- package/dist/icons/index.js +2 -2
- package/dist/index-BTeHvysI.d.ts +807 -0
- package/dist/index-BTeHvysI.d.ts.map +1 -0
- package/dist/index-DySzkJlC.d.ts +78 -0
- package/dist/index-DySzkJlC.d.ts.map +1 -0
- package/dist/index.d.ts +5 -8
- package/dist/index.js +6 -100
- package/dist/mdx/provider.d.ts +61 -4
- package/dist/mdx/provider.d.ts.map +1 -0
- package/dist/mdx/provider.js +89 -117
- package/dist/mdx/provider.js.map +1 -1
- package/dist/runtime/index.d.ts +2 -41
- package/dist/runtime/index.js +2 -28
- package/dist/sidebar-utils-1Skqle1Q.js +109 -0
- package/dist/sidebar-utils-1Skqle1Q.js.map +1 -0
- package/dist/theme/index.d.ts +201 -182
- package/dist/theme/index.d.ts.map +1 -0
- package/dist/theme/index.js +288 -128
- package/dist/theme/index.js.map +1 -1
- package/dist/typedoc/components/index.d.ts +55 -0
- package/dist/typedoc/components/index.d.ts.map +1 -0
- package/dist/typedoc/components/index.js +339 -0
- package/dist/typedoc/components/index.js.map +1 -0
- package/dist/typedoc/index.d.ts +36 -305
- package/dist/typedoc/index.d.ts.map +1 -0
- package/dist/typedoc/index.js +97 -268
- package/dist/typedoc/index.js.map +1 -1
- package/dist/types-BCuJBsJu.d.ts +182 -0
- package/dist/types-BCuJBsJu.d.ts.map +1 -0
- package/dist/types-CTd_mkrv.d.ts +175 -0
- package/dist/types-CTd_mkrv.d.ts.map +1 -0
- package/dist/ui/index.d.ts +2 -178
- package/dist/ui/index.js +3 -95
- package/dist/ui/styles.css +1401 -1335
- package/dist/ui/styles.d.ts +1 -2
- package/dist/ui/styles.js +23 -4
- package/dist/ui-3grzJSsq.js +1314 -0
- package/dist/ui-3grzJSsq.js.map +1 -0
- package/dist/vite/index.d.ts +78 -86
- package/dist/vite/index.d.ts.map +1 -0
- package/dist/vite/index.js +2931 -1282
- package/dist/vite/index.js.map +1 -1
- package/package.json +30 -19
- package/dist/Features-D_Pt7zpA.d.ts +0 -615
- package/dist/Search-DOJMNI2T.css +0 -193
- package/dist/Search-DOJMNI2T.css.map +0 -1
- package/dist/Search-VYYG3D43.js +0 -10
- package/dist/Search-VYYG3D43.js.map +0 -1
- package/dist/chunk-4YQE3TNM.js +0 -1
- package/dist/chunk-4YQE3TNM.js.map +0 -1
- package/dist/chunk-AXLJDGQL.js +0 -1
- package/dist/chunk-AXLJDGQL.js.map +0 -1
- package/dist/chunk-CZM5NX27.js +0 -909
- package/dist/chunk-CZM5NX27.js.map +0 -1
- package/dist/chunk-FZP2AVJL.js +0 -43
- package/dist/chunk-FZP2AVJL.js.map +0 -1
- package/dist/chunk-IEPSORG5.js +0 -444
- package/dist/chunk-IEPSORG5.js.map +0 -1
- package/dist/chunk-KUWEUO37.js +0 -1
- package/dist/chunk-KUWEUO37.js.map +0 -1
- package/dist/chunk-NBRHGTR2.js +0 -79
- package/dist/chunk-NBRHGTR2.js.map +0 -1
- package/dist/chunk-PGHUPTGL.js +0 -1035
- package/dist/chunk-PGHUPTGL.js.map +0 -1
- package/dist/chunk-PMS3P4MA.js +0 -43
- package/dist/chunk-PMS3P4MA.js.map +0 -1
- package/dist/chunk-QELSOHIY.js +0 -46
- package/dist/chunk-QELSOHIY.js.map +0 -1
- package/dist/chunk-R2QKY6G3.js +0 -1
- package/dist/chunk-R2QKY6G3.js.map +0 -1
- package/dist/chunk-ZPYQQZ7J.js +0 -210
- package/dist/chunk-ZPYQQZ7J.js.map +0 -1
- package/dist/icons/index.js.map +0 -1
- package/dist/index.css +0 -1290
- package/dist/index.css.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/mdx/provider.css +0 -403
- package/dist/mdx/provider.css.map +0 -1
- package/dist/runtime/index.js.map +0 -1
- package/dist/types-CLkHwCch.d.ts +0 -248
- package/dist/ui/index.css +0 -1290
- package/dist/ui/index.css.map +0 -1
- package/dist/ui/index.js.map +0 -1
- package/dist/ui/styles.css.map +0 -1
- package/dist/ui/styles.js.map +0 -1
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
import { PluggableList } from "unified";
|
|
2
|
+
import { BundledTheme } from "shiki";
|
|
3
|
+
|
|
4
|
+
//#region src/config/types.d.ts
|
|
5
|
+
type SidebarItem = {
|
|
6
|
+
text: string;
|
|
7
|
+
link?: string;
|
|
8
|
+
collapsed?: boolean;
|
|
9
|
+
items?: SidebarItem[];
|
|
10
|
+
};
|
|
11
|
+
type NavItem = {
|
|
12
|
+
text: string;
|
|
13
|
+
link?: string;
|
|
14
|
+
items?: NavItem[];
|
|
15
|
+
activeMatch?: string;
|
|
16
|
+
};
|
|
17
|
+
type SponsorConfig = {
|
|
18
|
+
text: string;
|
|
19
|
+
link: string;
|
|
20
|
+
};
|
|
21
|
+
type SocialLink = {
|
|
22
|
+
icon: "discord" | "github" | "linkedin" | "npm" | "twitter" | "youtube";
|
|
23
|
+
link: string;
|
|
24
|
+
ariaLabel?: string;
|
|
25
|
+
};
|
|
26
|
+
type MarkdownConfig = {
|
|
27
|
+
/** Syntax highlighting theme */theme?: {
|
|
28
|
+
light: BundledTheme;
|
|
29
|
+
dark: BundledTheme;
|
|
30
|
+
} | BundledTheme; /** Show line numbers in code blocks */
|
|
31
|
+
lineNumbers?: boolean; /** Enable anchor links for headings */
|
|
32
|
+
anchor?: boolean; /** Table of contents configuration */
|
|
33
|
+
toc?: {
|
|
34
|
+
level?: [number, number];
|
|
35
|
+
}; /** Remark plugins */
|
|
36
|
+
remarkPlugins?: PluggableList; /** Rehype plugins */
|
|
37
|
+
rehypePlugins?: PluggableList;
|
|
38
|
+
};
|
|
39
|
+
type HeadConfig = {
|
|
40
|
+
tag: string;
|
|
41
|
+
attrs?: Record<string, boolean | string>;
|
|
42
|
+
children?: string;
|
|
43
|
+
};
|
|
44
|
+
type TypeDocConfig = {
|
|
45
|
+
enabled?: boolean;
|
|
46
|
+
entryPoints: string[];
|
|
47
|
+
tsconfig?: string;
|
|
48
|
+
out?: string;
|
|
49
|
+
readme?: string;
|
|
50
|
+
plugin?: string[];
|
|
51
|
+
exclude?: string[];
|
|
52
|
+
excludeExternals?: boolean;
|
|
53
|
+
excludePrivate?: boolean;
|
|
54
|
+
excludeProtected?: boolean;
|
|
55
|
+
excludeInternal?: boolean;
|
|
56
|
+
sort?: Array<"alphabetical" | "enum-value-ascending" | "enum-value-descending" | "required-first" | "source-order" | "visibility">;
|
|
57
|
+
categoryOrder?: string[];
|
|
58
|
+
groupOrder?: string[];
|
|
59
|
+
watch?: boolean;
|
|
60
|
+
sidebar?: {
|
|
61
|
+
title?: string;
|
|
62
|
+
position?: number;
|
|
63
|
+
collapsed?: boolean;
|
|
64
|
+
};
|
|
65
|
+
markdown?: {
|
|
66
|
+
breadcrumbs?: boolean;
|
|
67
|
+
hierarchy?: boolean;
|
|
68
|
+
sourceLinks?: boolean;
|
|
69
|
+
sourceBaseUrl?: string;
|
|
70
|
+
codeBlocks?: boolean;
|
|
71
|
+
};
|
|
72
|
+
};
|
|
73
|
+
type ProjectMeta = {
|
|
74
|
+
/** Package name from package.json */name?: string; /** Homepage URL from package.json */
|
|
75
|
+
homepage?: string; /** Repository URL (resolved from package.json repository field) */
|
|
76
|
+
repository?: string; /** Package version */
|
|
77
|
+
version?: string; /** Package author */
|
|
78
|
+
author?: string; /** Package license */
|
|
79
|
+
license?: string;
|
|
80
|
+
};
|
|
81
|
+
/**
|
|
82
|
+
* Main Ardo configuration.
|
|
83
|
+
*
|
|
84
|
+
* In JSX-first architecture, only build-time options are needed here.
|
|
85
|
+
* Runtime UI configuration (header, sidebar, footer) is done in JSX.
|
|
86
|
+
*/
|
|
87
|
+
type ArdoConfig = {
|
|
88
|
+
/** Site title (used for default meta tags) */title: string; /** Site description (used for default meta tags) */
|
|
89
|
+
description?: string; /** Separator between page title and site title (default: " | ") */
|
|
90
|
+
titleSeparator?: string; /** Base URL path */
|
|
91
|
+
base?: string; /** Content source directory (default: 'content') */
|
|
92
|
+
srcDir?: string; /** Build output directory (default: 'dist') */
|
|
93
|
+
outDir?: string; /** Site language (default: 'en') */
|
|
94
|
+
lang?: string; /** Additional head tags (deprecated: use React Router Meta instead) */
|
|
95
|
+
head?: HeadConfig[]; /** Markdown processing options */
|
|
96
|
+
markdown?: MarkdownConfig;
|
|
97
|
+
/**
|
|
98
|
+
* TypeDoc API documentation generation.
|
|
99
|
+
* - `true`: Enable with defaults (./src/index.ts → content/api-reference/)
|
|
100
|
+
* - `{ ... }`: Enable with custom config
|
|
101
|
+
*/
|
|
102
|
+
typedoc?: true | TypeDocConfig; /** Custom Vite configuration */
|
|
103
|
+
vite?: Record<string, unknown>;
|
|
104
|
+
/**
|
|
105
|
+
* Project metadata (auto-detected from package.json if not provided).
|
|
106
|
+
* Available at runtime via `config.project` from `virtual:ardo/config`.
|
|
107
|
+
*/
|
|
108
|
+
project?: ProjectMeta; /** Build timestamp (ISO string, set automatically by the Vite plugin) */
|
|
109
|
+
buildTime?: string; /** Git commit hash (set automatically by the Vite plugin) */
|
|
110
|
+
buildHash?: string;
|
|
111
|
+
};
|
|
112
|
+
type PageFrontmatter = {
|
|
113
|
+
title?: string;
|
|
114
|
+
description?: string;
|
|
115
|
+
layout?: "doc" | "home" | "page";
|
|
116
|
+
sidebar?: boolean;
|
|
117
|
+
outline?: [number, number] | boolean | number;
|
|
118
|
+
editLink?: boolean;
|
|
119
|
+
lastUpdated?: boolean;
|
|
120
|
+
prev?: {
|
|
121
|
+
text: string;
|
|
122
|
+
link: string;
|
|
123
|
+
} | false | string;
|
|
124
|
+
next?: {
|
|
125
|
+
text: string;
|
|
126
|
+
link: string;
|
|
127
|
+
} | false | string;
|
|
128
|
+
hero?: {
|
|
129
|
+
name?: string;
|
|
130
|
+
text?: string;
|
|
131
|
+
tagline?: string;
|
|
132
|
+
image?: {
|
|
133
|
+
light: string;
|
|
134
|
+
dark: string;
|
|
135
|
+
} | string;
|
|
136
|
+
actions?: Array<{
|
|
137
|
+
text: string;
|
|
138
|
+
link: string;
|
|
139
|
+
theme?: "alt" | "brand";
|
|
140
|
+
}>;
|
|
141
|
+
};
|
|
142
|
+
features?: Array<{
|
|
143
|
+
icon?: string;
|
|
144
|
+
title: string;
|
|
145
|
+
details: string;
|
|
146
|
+
link?: string;
|
|
147
|
+
linkText?: string;
|
|
148
|
+
}>;
|
|
149
|
+
} & Record<string, unknown>;
|
|
150
|
+
type TOCItem = {
|
|
151
|
+
id: string;
|
|
152
|
+
text: string;
|
|
153
|
+
level: number;
|
|
154
|
+
children?: TOCItem[];
|
|
155
|
+
};
|
|
156
|
+
type PageData = {
|
|
157
|
+
title: string;
|
|
158
|
+
description?: string;
|
|
159
|
+
frontmatter: PageFrontmatter;
|
|
160
|
+
content: string;
|
|
161
|
+
toc: TOCItem[];
|
|
162
|
+
lastUpdated?: number;
|
|
163
|
+
filePath: string;
|
|
164
|
+
relativePath: string;
|
|
165
|
+
};
|
|
166
|
+
type ResolvedConfig = {
|
|
167
|
+
project: ProjectMeta;
|
|
168
|
+
vite?: Record<string, unknown>;
|
|
169
|
+
typedoc?: TypeDocConfig;
|
|
170
|
+
root: string;
|
|
171
|
+
contentDir: string;
|
|
172
|
+
} & Required<Omit<ArdoConfig, "buildHash" | "buildTime" | "project" | "typedoc" | "vite">>;
|
|
173
|
+
//#endregion
|
|
174
|
+
export { PageData as a, ResolvedConfig as c, SponsorConfig as d, TOCItem as f, NavItem as i, SidebarItem as l, HeadConfig as n, PageFrontmatter as o, TypeDocConfig as p, MarkdownConfig as r, ProjectMeta as s, ArdoConfig as t, SocialLink as u };
|
|
175
|
+
//# sourceMappingURL=types-CTd_mkrv.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types-CTd_mkrv.d.ts","names":[],"sources":["../src/config/types.ts"],"mappings":";;;;KAOY,WAAA;EACV,IAAA;EACA,IAAA;EACA,SAAA;EACA,KAAA,GAAQ,WAAA;AAAA;AAAA,KAOE,OAAA;EACV,IAAA;EACA,IAAA;EACA,KAAA,GAAQ,OAAA;EACR,WAAA;AAAA;AAAA,KAOU,aAAA;EACV,IAAA;EACA,IAAA;AAAA;AAAA,KAOU,UAAA;EACV,IAAA;EACA,IAAA;EACA,SAAA;AAAA;AAAA,KAOU,cAAA;EA1BC,gCA4BX,KAAA;IAAU,KAAA,EAAO,YAAA;IAAc,IAAA,EAAM,YAAA;EAAA,IAAiB,YAAA,EApBtD;EAsBA,WAAA,YAdU;EAgBV,MAAA;EAEA,GAAA;IACE,KAAA;EAAA,GAhBF;EAmBA,aAAA,GAAgB,aAAA,EAnBP;EAqBT,aAAA,GAAgB,aAAA;AAAA;AAAA,KAON,UAAA;EACV,GAAA;EACA,KAAA,GAAQ,MAAA;EACR,QAAA;AAAA;AAAA,KAOU,aAAA;EACV,OAAA;EACA,WAAA;EACA,QAAA;EACA,GAAA;EACA,MAAA;EACA,MAAA;EACA,OAAA;EACA,gBAAA;EACA,cAAA;EACA,gBAAA;EACA,eAAA;EACA,IAAA,GAAO,KAAA;EAQP,aAAA;EACA,UAAA;EACA,KAAA;EACA,OAAA;IACE,KAAA;IACA,QAAA;IACA,SAAA;EAAA;EAEF,QAAA;IACE,WAAA;IACA,SAAA;IACA,WAAA;IACA,aAAA;IACA,UAAA;EAAA;AAAA;AAAA,KAQQ,WAAA;EAzCa,qCA2CvB,IAAA,WA/BY;EAiCZ,QAAA,WA3CA;EA6CA,UAAA,WA3CA;EA6CA,OAAA,WA3CA;EA6CA,MAAA,WA3CA;EA6CA,OAAA;AAAA;;;;;;;KAaU,UAAA;EA1CR,8CA4CF,KAAA,UA1CE;EA4CF,WAAA,WAzCE;EA2CF,cAAA,WAzCE;EA2CF,IAAA,WAzCE;EA2CF,MAAA,WA3CY;EA6CZ,MAAA,WArCqB;EAuCrB,IAAA,WAvCqB;EAyCrB,IAAA,GAAO,UAAA,IArCP;EAuCA,QAAA,GAAW,cAAA;EAnCX;;;;;EAyCA,OAAA,UAAiB,aAAA,EAxBG;EA0BpB,IAAA,GAAO,MAAA;EAVA;;;;EAeP,OAAA,GAAU,WAAA,EAAW;EAErB,SAAA,WA/BA;EAiCA,SAAA;AAAA;AAAA,KAOU,eAAA;EACV,KAAA;EACA,WAAA;EACA,MAAA;EACA,OAAA;EACA,OAAA;EACA,QAAA;EACA,WAAA;EACA,IAAA;IAAS,IAAA;IAAc,IAAA;EAAA;EACvB,IAAA;IAAS,IAAA;IAAc,IAAA;EAAA;EACvB,IAAA;IACE,IAAA;IACA,IAAA;IACA,OAAA;IACA,KAAA;MAAU,KAAA;MAAe,IAAA;IAAA;IACzB,OAAA,GAAU,KAAA;MACR,IAAA;MACA,IAAA;MACA,KAAA;IAAA;EAAA;EAGJ,QAAA,GAAW,KAAA;IACT,IAAA;IACA,KAAA;IACA,OAAA;IACA,IAAA;IACA,QAAA;EAAA;AAAA,IAEA,MAAA;AAAA,KAEQ,OAAA;EACV,EAAA;EACA,IAAA;EACA,KAAA;EACA,QAAA,GAAW,OAAA;AAAA;AAAA,KAGD,QAAA;EACV,KAAA;EACA,WAAA;EACA,WAAA,EAAa,eAAA;EACb,OAAA;EACA,GAAA,EAAK,OAAA;EACL,WAAA;EACA,QAAA;EACA,YAAA;AAAA;AAAA,KAOU,cAAA;EACV,OAAA,EAAS,WAAA;EACT,IAAA,GAAO,MAAA;EACP,OAAA,GAAU,aAAA;EACV,IAAA;EACA,UAAA;AAAA,IACE,QAAA,CAAS,IAAA,CAAK,UAAA"}
|
package/dist/ui/index.d.ts
CHANGED
|
@@ -1,178 +1,2 @@
|
|
|
1
|
-
import { V as
|
|
2
|
-
export {
|
|
3
|
-
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
4
|
-
import { ReactNode, ComponentProps, SVGAttributes, ComponentType } from 'react';
|
|
5
|
-
import { A as ArdoConfig, S as SidebarItem } from '../types-CLkHwCch.js';
|
|
6
|
-
import { NavLink as NavLink$1 } from 'react-router';
|
|
7
|
-
import 'shiki';
|
|
8
|
-
|
|
9
|
-
interface ArdoRootProps {
|
|
10
|
-
/** Ardo config (from virtual:ardo/config) */
|
|
11
|
-
config: ArdoConfig;
|
|
12
|
-
/** Sidebar data (from virtual:ardo/sidebar) */
|
|
13
|
-
sidebar: SidebarItem[];
|
|
14
|
-
/** Custom header element (overrides auto-generated header) */
|
|
15
|
-
header?: ReactNode;
|
|
16
|
-
/** Custom sidebar element (overrides auto-generated sidebar) */
|
|
17
|
-
sidebarContent?: ReactNode;
|
|
18
|
-
/** Custom footer element (overrides auto-generated footer) */
|
|
19
|
-
footer?: ReactNode;
|
|
20
|
-
/** Props passed to auto-generated Header (ignored when header is provided) */
|
|
21
|
-
headerProps?: HeaderProps;
|
|
22
|
-
/** Props passed to auto-generated Sidebar (ignored when sidebarContent is provided) */
|
|
23
|
-
sidebarProps?: SidebarProps;
|
|
24
|
-
/** Props passed to auto-generated Footer (ignored when footer is provided) */
|
|
25
|
-
footerProps?: FooterProps;
|
|
26
|
-
/** Additional CSS classes for the layout */
|
|
27
|
-
className?: string;
|
|
28
|
-
/** Content to render (defaults to <Outlet />) */
|
|
29
|
-
children?: ReactNode;
|
|
30
|
-
}
|
|
31
|
-
/**
|
|
32
|
-
* All-in-one root component that combines ArdoProvider, Layout, Header,
|
|
33
|
-
* Sidebar, Footer, and homepage detection into a single component.
|
|
34
|
-
*
|
|
35
|
-
* @example Minimal usage
|
|
36
|
-
* ```tsx
|
|
37
|
-
* import config from "virtual:ardo/config"
|
|
38
|
-
* import sidebar from "virtual:ardo/sidebar"
|
|
39
|
-
*
|
|
40
|
-
* export default function Root() {
|
|
41
|
-
* return <ArdoRoot config={config} sidebar={sidebar} />
|
|
42
|
-
* }
|
|
43
|
-
* ```
|
|
44
|
-
*
|
|
45
|
-
* @example With custom nav and footer overrides
|
|
46
|
-
* ```tsx
|
|
47
|
-
* export default function Root() {
|
|
48
|
-
* return (
|
|
49
|
-
* <ArdoRoot
|
|
50
|
-
* config={config}
|
|
51
|
-
* sidebar={sidebar}
|
|
52
|
-
* headerProps={{
|
|
53
|
-
* nav: (
|
|
54
|
-
* <Nav>
|
|
55
|
-
* <NavLink to="/guide">Guide</NavLink>
|
|
56
|
-
* <NavLink to="/api">API</NavLink>
|
|
57
|
-
* </Nav>
|
|
58
|
-
* ),
|
|
59
|
-
* }}
|
|
60
|
-
* footerProps={{
|
|
61
|
-
* message: "Released under the MIT License.",
|
|
62
|
-
* }}
|
|
63
|
-
* />
|
|
64
|
-
* )
|
|
65
|
-
* }
|
|
66
|
-
* ```
|
|
67
|
-
*/
|
|
68
|
-
declare function ArdoRoot({ config, sidebar, header, sidebarContent, footer, headerProps, sidebarProps, footerProps, className, children, }: ArdoRootProps): react_jsx_runtime.JSX.Element;
|
|
69
|
-
|
|
70
|
-
/** Route path type - uses React Router's NavLink 'to' prop type for type-safe routes */
|
|
71
|
-
type RoutePath = ComponentProps<typeof NavLink$1>["to"];
|
|
72
|
-
interface NavProps {
|
|
73
|
-
children?: ReactNode;
|
|
74
|
-
className?: string;
|
|
75
|
-
}
|
|
76
|
-
/**
|
|
77
|
-
* Navigation container component for composing navigation links.
|
|
78
|
-
*
|
|
79
|
-
* @example
|
|
80
|
-
* ```tsx
|
|
81
|
-
* <Nav>
|
|
82
|
-
* <NavLink to="/guide">Guide</NavLink>
|
|
83
|
-
* <NavLink to="/api">API</NavLink>
|
|
84
|
-
* <NavLink href="https://github.com/...">GitHub</NavLink>
|
|
85
|
-
* </Nav>
|
|
86
|
-
* ```
|
|
87
|
-
*/
|
|
88
|
-
declare function Nav({ children, className }: NavProps): react_jsx_runtime.JSX.Element;
|
|
89
|
-
interface NavLinkProps {
|
|
90
|
-
/** Internal route path (type-safe with React Router's registered routes) */
|
|
91
|
-
to?: RoutePath;
|
|
92
|
-
/** External URL (uses anchor tag) */
|
|
93
|
-
href?: string;
|
|
94
|
-
/** Link text or children */
|
|
95
|
-
children: ReactNode;
|
|
96
|
-
/** Additional CSS classes */
|
|
97
|
-
className?: string;
|
|
98
|
-
/** Active state match pattern */
|
|
99
|
-
activeMatch?: string;
|
|
100
|
-
}
|
|
101
|
-
/**
|
|
102
|
-
* Navigation link component supporting both internal routes and external URLs.
|
|
103
|
-
*
|
|
104
|
-
* @example
|
|
105
|
-
* ```tsx
|
|
106
|
-
* // Internal link
|
|
107
|
-
* <NavLink to="/guide">Guide</NavLink>
|
|
108
|
-
*
|
|
109
|
-
* // External link
|
|
110
|
-
* <NavLink href="https://github.com/...">GitHub</NavLink>
|
|
111
|
-
* ```
|
|
112
|
-
*/
|
|
113
|
-
declare function NavLink({ to, href, children, className, activeMatch: _activeMatch, }: NavLinkProps): react_jsx_runtime.JSX.Element;
|
|
114
|
-
|
|
115
|
-
/**
|
|
116
|
-
* Wraps imported MDX content to render without the full Content wrapper
|
|
117
|
-
* (article, header, footer, navigation). Only the content body is rendered.
|
|
118
|
-
*
|
|
119
|
-
* ```tsx
|
|
120
|
-
* import MySnippet from "./snippet.mdx"
|
|
121
|
-
*
|
|
122
|
-
* <BareContent>
|
|
123
|
-
* <MySnippet />
|
|
124
|
-
* </BareContent>
|
|
125
|
-
* ```
|
|
126
|
-
*/
|
|
127
|
-
declare function BareContent({ children }: {
|
|
128
|
-
children: ReactNode;
|
|
129
|
-
}): react_jsx_runtime.JSX.Element;
|
|
130
|
-
|
|
131
|
-
type IconComponent = ComponentType<SVGAttributes<SVGSVGElement> & {
|
|
132
|
-
size?: number;
|
|
133
|
-
}>;
|
|
134
|
-
interface IconProps extends SVGAttributes<SVGSVGElement> {
|
|
135
|
-
/** Name of the registered icon */
|
|
136
|
-
name: string;
|
|
137
|
-
/** Icon size */
|
|
138
|
-
size?: number;
|
|
139
|
-
}
|
|
140
|
-
/**
|
|
141
|
-
* Register icons for use with the Icon component.
|
|
142
|
-
* Only registered icons are included in your bundle.
|
|
143
|
-
*
|
|
144
|
-
* @example
|
|
145
|
-
* ```tsx
|
|
146
|
-
* // In your app's entry point or layout:
|
|
147
|
-
* import { registerIcons } from "ardo/ui"
|
|
148
|
-
* import { Zap, Rocket, Code } from "lucide-react"
|
|
149
|
-
*
|
|
150
|
-
* registerIcons({ Zap, Rocket, Code })
|
|
151
|
-
* ```
|
|
152
|
-
*/
|
|
153
|
-
declare function registerIcons(icons: Record<string, IconComponent>): void;
|
|
154
|
-
/**
|
|
155
|
-
* Get all registered icon names (useful for documentation).
|
|
156
|
-
*/
|
|
157
|
-
declare function getRegisteredIconNames(): string[];
|
|
158
|
-
/**
|
|
159
|
-
* Renders a registered icon by name.
|
|
160
|
-
* Icons must be registered first using `registerIcons()`.
|
|
161
|
-
*
|
|
162
|
-
* @example
|
|
163
|
-
* ```tsx
|
|
164
|
-
* // First register icons in your app:
|
|
165
|
-
* import { registerIcons } from "ardo/ui"
|
|
166
|
-
* import { Zap, Rocket } from "lucide-react"
|
|
167
|
-
* registerIcons({ Zap, Rocket })
|
|
168
|
-
*
|
|
169
|
-
* // Then use in MDX:
|
|
170
|
-
* <Icon name="Zap" size={24} />
|
|
171
|
-
* <Icon name="Rocket" className="text-brand" />
|
|
172
|
-
* ```
|
|
173
|
-
*
|
|
174
|
-
* @see https://lucide.dev/icons for available icon names
|
|
175
|
-
*/
|
|
176
|
-
declare function Icon({ name, ...props }: IconProps): ReactNode;
|
|
177
|
-
|
|
178
|
-
export { ArdoRoot, type ArdoRootProps, BareContent, FooterProps, HeaderProps, Icon, type IconProps, Nav, NavLink, type NavLinkProps, type NavProps, SidebarProps, getRegisteredIconNames, registerIcons };
|
|
1
|
+
import { $ as ArdoTip, A as ArdoSearch, B as ArdoFeatureCardProps, C as ArdoTabPanels, Ct as ArdoFooterProps, D as ArdoTabsProps, E as ArdoTabs, F as ArdoHero, G as ArdoContainerProps, H as ArdoFeaturesProps, I as ArdoHeroAction, J as ArdoDangerProps, K as ArdoContainerType, L as ArdoHeroImage, M as ArdoIconProps, N as getRegisteredIconNames, O as ArdoSteps, P as registerIcons, Q as ArdoNoteProps, R as ArdoHeroProps, S as ArdoTabPanelProps, St as ArdoFooterMessageProps, T as ArdoTabProps, U as ArdoCopyButton, V as ArdoFeatures, W as ArdoContainer, X as ArdoInfoProps, Y as ArdoInfo, Z as ArdoNote, _ as ArdoThemeToggle, _t as ArdoHeaderProps, a as ArdoNavLinkProps, at as ArdoCodeGroup, b as ArdoTabListProps, bt as ArdoFooter, c as ArdoLayoutProps, ct as ArdoRoot, d as ArdoHomePage, dt as ArdoSidebarGroup, et as ArdoTipProps, f as ArdoHomePageProps, ft as ArdoSidebarGroupProps, g as ArdoContent, gt as ArdoHeader, h as ArdoDocPage, ht as ArdoSidebarProps, i as ArdoNavLink, it as ArdoCodeBlockProps, j as ArdoIcon, k as ArdoStepsProps, l as ArdoRootLayout, lt as ArdoRootProps, m as ArdoDocLayout, mt as ArdoSidebarLinkProps, n as ArdoTOCProps, nt as ArdoWarningProps, o as ArdoNavProps, ot as ArdoCodeGroupProps, p as ArdoDocContent, pt as ArdoSidebarLink, q as ArdoDanger, r as ArdoNav, rt as ArdoCodeBlock, s as ArdoLayout, st as ArdoBareContent, t as ArdoTOC, tt as ArdoWarning, u as ArdoRootLayoutProps, ut as ArdoSidebar, v as ArdoTab, vt as ArdoSocialLink, w as ArdoTabPanelsProps, x as ArdoTabPanel, xt as ArdoFooterCopyrightProps, y as ArdoTabList, yt as ArdoSocialLinkProps, z as ArdoFeatureCard } from "../index-BTeHvysI.js";
|
|
2
|
+
export { ArdoBareContent, ArdoCodeBlock, ArdoCodeBlockProps, ArdoCodeGroup, ArdoCodeGroupProps, ArdoContainer, ArdoContainerProps, ArdoContainerType, ArdoContent, ArdoCopyButton, ArdoDanger, ArdoDangerProps, ArdoDocContent, ArdoDocLayout, ArdoDocPage, ArdoFeatureCard, ArdoFeatureCardProps, ArdoFeatures, ArdoFeaturesProps, ArdoFooter, ArdoFooterCopyrightProps, ArdoFooterMessageProps, ArdoFooterProps, ArdoHeader, ArdoHeaderProps, ArdoHero, ArdoHeroAction, ArdoHeroImage, ArdoHeroProps, ArdoHomePage, ArdoHomePageProps, ArdoIcon, ArdoIconProps, ArdoInfo, ArdoInfoProps, ArdoLayout, ArdoLayoutProps, ArdoNav, ArdoNavLink, ArdoNavLinkProps, ArdoNavProps, ArdoNote, ArdoNoteProps, ArdoRoot, ArdoRootLayout, ArdoRootLayoutProps, ArdoRootProps, ArdoSearch, ArdoSidebar, ArdoSidebarGroup, ArdoSidebarGroupProps, ArdoSidebarLink, ArdoSidebarLinkProps, ArdoSidebarProps, ArdoSocialLink, ArdoSocialLinkProps, ArdoSteps, ArdoStepsProps, ArdoTOC, ArdoTOCProps, ArdoTab, ArdoTabList, ArdoTabListProps, ArdoTabPanel, ArdoTabPanelProps, ArdoTabPanels, ArdoTabPanelsProps, ArdoTabProps, ArdoTabs, ArdoTabsProps, ArdoThemeToggle, ArdoTip, ArdoTipProps, ArdoWarning, ArdoWarningProps, getRegisteredIconNames, registerIcons };
|
package/dist/ui/index.js
CHANGED
|
@@ -1,95 +1,3 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
DocLayout,
|
|
5
|
-
DocPage,
|
|
6
|
-
FeatureCard,
|
|
7
|
-
Features,
|
|
8
|
-
Footer,
|
|
9
|
-
Header,
|
|
10
|
-
Hero,
|
|
11
|
-
HomePage,
|
|
12
|
-
Layout,
|
|
13
|
-
Nav,
|
|
14
|
-
NavLink,
|
|
15
|
-
RootLayout,
|
|
16
|
-
Sidebar,
|
|
17
|
-
SidebarGroup,
|
|
18
|
-
SidebarLink,
|
|
19
|
-
SocialLink,
|
|
20
|
-
TOC,
|
|
21
|
-
ThemeToggle
|
|
22
|
-
} from "../chunk-CZM5NX27.js";
|
|
23
|
-
import "../chunk-KUWEUO37.js";
|
|
24
|
-
import {
|
|
25
|
-
Search
|
|
26
|
-
} from "../chunk-ZPYQQZ7J.js";
|
|
27
|
-
import "../chunk-4YQE3TNM.js";
|
|
28
|
-
import {
|
|
29
|
-
BareContent,
|
|
30
|
-
CodeBlock,
|
|
31
|
-
CodeGroup,
|
|
32
|
-
Container,
|
|
33
|
-
Content,
|
|
34
|
-
CopyButton,
|
|
35
|
-
Danger,
|
|
36
|
-
Icon,
|
|
37
|
-
Info,
|
|
38
|
-
Note,
|
|
39
|
-
Tab,
|
|
40
|
-
TabList,
|
|
41
|
-
TabPanel,
|
|
42
|
-
TabPanels,
|
|
43
|
-
Tabs,
|
|
44
|
-
Tip,
|
|
45
|
-
Warning,
|
|
46
|
-
getRegisteredIconNames,
|
|
47
|
-
registerIcons
|
|
48
|
-
} from "../chunk-IEPSORG5.js";
|
|
49
|
-
import "../chunk-AXLJDGQL.js";
|
|
50
|
-
import "../chunk-PMS3P4MA.js";
|
|
51
|
-
import "../chunk-FZP2AVJL.js";
|
|
52
|
-
import "../chunk-QELSOHIY.js";
|
|
53
|
-
export {
|
|
54
|
-
ArdoRoot,
|
|
55
|
-
BareContent,
|
|
56
|
-
CodeBlock,
|
|
57
|
-
CodeGroup,
|
|
58
|
-
Container,
|
|
59
|
-
Content,
|
|
60
|
-
CopyButton,
|
|
61
|
-
Danger,
|
|
62
|
-
DocContent,
|
|
63
|
-
DocLayout,
|
|
64
|
-
DocPage,
|
|
65
|
-
FeatureCard,
|
|
66
|
-
Features,
|
|
67
|
-
Footer,
|
|
68
|
-
Header,
|
|
69
|
-
Hero,
|
|
70
|
-
HomePage,
|
|
71
|
-
Icon,
|
|
72
|
-
Info,
|
|
73
|
-
Layout,
|
|
74
|
-
Nav,
|
|
75
|
-
NavLink,
|
|
76
|
-
Note,
|
|
77
|
-
RootLayout,
|
|
78
|
-
Search,
|
|
79
|
-
Sidebar,
|
|
80
|
-
SidebarGroup,
|
|
81
|
-
SidebarLink,
|
|
82
|
-
SocialLink,
|
|
83
|
-
TOC,
|
|
84
|
-
Tab,
|
|
85
|
-
TabList,
|
|
86
|
-
TabPanel,
|
|
87
|
-
TabPanels,
|
|
88
|
-
Tabs,
|
|
89
|
-
ThemeToggle,
|
|
90
|
-
Tip,
|
|
91
|
-
Warning,
|
|
92
|
-
getRegisteredIconNames,
|
|
93
|
-
registerIcons
|
|
94
|
-
};
|
|
95
|
-
//# sourceMappingURL=index.js.map
|
|
1
|
+
import { C as ArdoCopyButton, D as ArdoBareContent, O as ArdoLayout, S as ArdoCodeGroup, _ as ArdoInfo, a as ArdoContent, b as ArdoWarning, c as ArdoTabPanel, d as ArdoSteps, f as ArdoIcon, g as ArdoDanger, h as ArdoContainer, i as ArdoTOC, k as ArdoRootLayout, l as ArdoTabPanels, m as registerIcons, n as ArdoDocLayout, o as ArdoTab, p as getRegisteredIconNames, r as ArdoDocPage, s as ArdoTabList, t as ArdoDocContent, u as ArdoTabs, v as ArdoNote, x as ArdoCodeBlock, y as ArdoTip } from "../DocPage-CIBiCAxZ.js";
|
|
2
|
+
import { a as ArdoFeatureCard, c as ArdoSidebar, d as ArdoHeader, f as ArdoSocialLink, h as ArdoSearch, i as ArdoHero, l as ArdoSidebarGroup, m as ArdoFooter, n as ArdoNavLink, o as ArdoFeatures, p as ArdoThemeToggle, r as ArdoHomePage, s as ArdoRoot, t as ArdoNav, u as ArdoSidebarLink } from "../ui-3grzJSsq.js";
|
|
3
|
+
export { ArdoBareContent, ArdoCodeBlock, ArdoCodeGroup, ArdoContainer, ArdoContent, ArdoCopyButton, ArdoDanger, ArdoDocContent, ArdoDocLayout, ArdoDocPage, ArdoFeatureCard, ArdoFeatures, ArdoFooter, ArdoHeader, ArdoHero, ArdoHomePage, ArdoIcon, ArdoInfo, ArdoLayout, ArdoNav, ArdoNavLink, ArdoNote, ArdoRoot, ArdoRootLayout, ArdoSearch, ArdoSidebar, ArdoSidebarGroup, ArdoSidebarLink, ArdoSocialLink, ArdoSteps, ArdoTOC, ArdoTab, ArdoTabList, ArdoTabPanel, ArdoTabPanels, ArdoTabs, ArdoThemeToggle, ArdoTip, ArdoWarning, getRegisteredIconNames, registerIcons };
|