@krizaka/ui 2.9.0 → 2.10.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.
- package/README.md +41 -5
- package/dist/blocks.css +247 -0
- package/dist/catalogue-page.d.ts +34 -0
- package/dist/catalogue-page.js +26 -0
- package/dist/catalogue-page.js.map +1 -0
- package/dist/changelog-page.d.ts +50 -0
- package/dist/changelog-page.js +27 -0
- package/dist/changelog-page.js.map +1 -0
- package/dist/{chunk-NOVUREEC.js → chunk-JZPVUJIX.js} +25 -3
- package/dist/chunk-JZPVUJIX.js.map +1 -0
- package/dist/chunk-KNBYZGSQ.js +11 -0
- package/dist/chunk-KNBYZGSQ.js.map +1 -0
- package/dist/component-page.d.ts +41 -0
- package/dist/component-page.js +17 -0
- package/dist/component-page.js.map +1 -0
- package/dist/contact-page.d.ts +31 -0
- package/dist/contact-page.js +26 -0
- package/dist/contact-page.js.map +1 -0
- package/dist/docs-article-page.d.ts +54 -0
- package/dist/docs-article-page.js +29 -0
- package/dist/docs-article-page.js.map +1 -0
- package/dist/docs-hub-page.d.ts +72 -0
- package/dist/docs-hub-page.js +45 -0
- package/dist/docs-hub-page.js.map +1 -0
- package/dist/error-page.d.ts +22 -0
- package/dist/error-page.js +23 -0
- package/dist/error-page.js.map +1 -0
- package/dist/gallery-page.d.ts +50 -0
- package/dist/gallery-page.js +30 -0
- package/dist/gallery-page.js.map +1 -0
- package/dist/{geometry-CXrAW34x.d.ts → geometry-CbOU4rtL.d.ts} +4 -4
- package/dist/how-it-works-page.d.ts +48 -0
- package/dist/how-it-works-page.js +28 -0
- package/dist/how-it-works-page.js.map +1 -0
- package/dist/index.d.ts +11 -2
- package/dist/index.js +93 -5
- package/dist/index.js.map +1 -1
- package/dist/landing-page.d.ts +58 -0
- package/dist/landing-page.js +42 -0
- package/dist/landing-page.js.map +1 -0
- package/dist/legal-page.d.ts +34 -0
- package/dist/legal-page.js +18 -0
- package/dist/legal-page.js.map +1 -0
- package/dist/longform-page.d.ts +42 -0
- package/dist/longform-page.js +29 -0
- package/dist/longform-page.js.map +1 -0
- package/dist/mascot-quote.d.ts +4 -4
- package/dist/mascot-quote.js +23 -1
- package/dist/mascot-quote.js.map +1 -1
- package/dist/mascot-state.d.ts +2 -2
- package/dist/mascot-state.js +1 -1
- package/dist/mascot-state.js.map +1 -1
- package/dist/mascots.d.ts +4 -4
- package/dist/mascots.js +1 -1
- package/dist/native.d.ts +16 -9
- package/dist/native.js +183 -74
- package/dist/native.js.map +1 -1
- package/dist/pricing-page.d.ts +62 -0
- package/dist/pricing-page.js +71 -0
- package/dist/pricing-page.js.map +1 -0
- package/dist/product-page.d.ts +83 -0
- package/dist/product-page.js +60 -0
- package/dist/product-page.js.map +1 -0
- package/dist/status-page.d.ts +42 -0
- package/dist/status-page.js +28 -0
- package/dist/status-page.js.map +1 -0
- package/package.json +233 -7
- package/registry/achievement.json +1 -1
- package/registry/action-bar.json +1 -1
- package/registry/alert.json +1 -1
- package/registry/app-shell.json +1 -1
- package/registry/argument-card.json +1 -1
- package/registry/audio-player.json +1 -1
- package/registry/auth-layout.json +1 -1
- package/registry/avatar.json +1 -1
- package/registry/badge.json +1 -1
- package/registry/button.json +1 -1
- package/registry/card-grid.json +1 -1
- package/registry/card.json +1 -1
- package/registry/catalogue-page.json +240 -0
- package/registry/changelog-page.json +226 -0
- package/registry/checkbox.json +1 -1
- package/registry/chip-link.json +1 -1
- package/registry/chip.json +1 -1
- package/registry/choice-grid.json +1 -1
- package/registry/code-block.json +1 -1
- package/registry/combobox.json +1 -1
- package/registry/command.json +1 -1
- package/registry/component-page.json +227 -0
- package/registry/confirm-button.json +1 -1
- package/registry/contact-page.json +212 -0
- package/registry/continue-prompt.json +1 -1
- package/registry/countdown.json +1 -1
- package/registry/cta-panel.json +1 -1
- package/registry/dashboard-layout.json +1 -1
- package/registry/data-table.json +1 -1
- package/registry/date-picker.json +1 -1
- package/registry/decision-list.json +1 -1
- package/registry/detail-layout.json +1 -1
- package/registry/dialog.json +1 -1
- package/registry/docs-article-page.json +242 -0
- package/registry/docs-hub-page.json +270 -0
- package/registry/docs-layout.json +1 -1
- package/registry/dropdown-menu.json +1 -1
- package/registry/empty-state.json +1 -1
- package/registry/error-page.json +183 -0
- package/registry/examples/catalogue-page/components.d.ts +4 -0
- package/registry/examples/catalogue-page/components.js +33 -0
- package/registry/examples/catalogue-page/components.tsx +36 -0
- package/registry/examples/changelog-page/releases.d.ts +4 -0
- package/registry/examples/changelog-page/releases.js +44 -0
- package/registry/examples/changelog-page/releases.tsx +39 -0
- package/registry/examples/component-page/button.d.ts +4 -0
- package/registry/examples/component-page/button.js +33 -0
- package/registry/examples/component-page/button.tsx +30 -0
- package/registry/examples/contact-page/team.d.ts +4 -0
- package/registry/examples/contact-page/team.js +39 -0
- package/registry/examples/contact-page/team.tsx +38 -0
- package/registry/examples/docs-article-page/cli.d.ts +4 -0
- package/registry/examples/docs-article-page/cli.js +33 -0
- package/registry/examples/docs-article-page/cli.tsx +38 -0
- package/registry/examples/docs-hub-page/krizaka.d.ts +4 -0
- package/registry/examples/docs-hub-page/krizaka.js +46 -0
- package/registry/examples/docs-hub-page/krizaka.tsx +37 -0
- package/registry/examples/error-page/not-found.d.ts +4 -0
- package/registry/examples/error-page/not-found.js +24 -0
- package/registry/examples/error-page/not-found.tsx +19 -0
- package/registry/examples/gallery-page/made-here.d.ts +4 -0
- package/registry/examples/gallery-page/made-here.js +34 -0
- package/registry/examples/gallery-page/made-here.tsx +32 -0
- package/registry/examples/how-it-works-page/orazaka.d.ts +4 -0
- package/registry/examples/how-it-works-page/orazaka.js +30 -0
- package/registry/examples/how-it-works-page/orazaka.tsx +26 -0
- package/registry/examples/landing-page/krizaka.d.ts +4 -0
- package/registry/examples/landing-page/krizaka.js +44 -0
- package/registry/examples/landing-page/krizaka.tsx +44 -0
- package/registry/examples/legal-page/privacy.d.ts +4 -0
- package/registry/examples/legal-page/privacy.js +24 -0
- package/registry/examples/legal-page/privacy.tsx +19 -0
- package/registry/examples/longform-page/story.d.ts +4 -0
- package/registry/examples/longform-page/story.js +38 -0
- package/registry/examples/longform-page/story.tsx +35 -0
- package/registry/examples/mascots/crane.d.ts +4 -0
- package/registry/examples/mascots/crane.js +19 -0
- package/registry/examples/mascots/crane.tsx +18 -0
- package/registry/examples/mascots/flock.tsx +2 -1
- package/registry/examples/mascots/native/crane.d.ts +4 -0
- package/registry/examples/mascots/native/crane.dark.png +0 -0
- package/registry/examples/mascots/native/crane.js +21 -0
- package/registry/examples/mascots/native/crane.light.png +0 -0
- package/registry/examples/mascots/native/crane.tsx +18 -0
- package/registry/examples/pricing-page/credits.d.ts +4 -0
- package/registry/examples/pricing-page/credits.js +41 -0
- package/registry/examples/pricing-page/credits.tsx +33 -0
- package/registry/examples/product-page/orazaka.d.ts +4 -0
- package/registry/examples/product-page/orazaka.js +44 -0
- package/registry/examples/product-page/orazaka.tsx +36 -0
- package/registry/examples/status-page/building.d.ts +4 -0
- package/registry/examples/status-page/building.js +29 -0
- package/registry/examples/status-page/building.tsx +25 -0
- package/registry/examples/status-page/operational.d.ts +4 -0
- package/registry/examples/status-page/operational.js +26 -0
- package/registry/examples/status-page/operational.tsx +20 -0
- package/registry/field.json +1 -1
- package/registry/file-upload.json +1 -1
- package/registry/filter-bar.json +1 -1
- package/registry/gallery-page.json +256 -0
- package/registry/glow-card.json +1 -1
- package/registry/goal-gauge.json +1 -1
- package/registry/how-it-works-page.json +242 -0
- package/registry/image-cropper.json +1 -1
- package/registry/index.json +309 -5
- package/registry/iso.json +1 -1
- package/registry/kbd.json +1 -1
- package/registry/landing-page.json +242 -0
- package/registry/landscape.json +1 -1
- package/registry/legal-page.json +199 -0
- package/registry/link-card.json +1 -1
- package/registry/loader.json +1 -1
- package/registry/longform-page.json +213 -0
- package/registry/marketing-layout.json +1 -1
- package/registry/marquee.json +1 -1
- package/registry/mascot-quote.json +6 -6
- package/registry/mascot-state.json +34 -34
- package/registry/mascots.json +41 -21
- package/registry/media-capture.json +1 -1
- package/registry/meter.json +1 -1
- package/registry/nav-bar.json +1 -1
- package/registry/number-ticker.json +1 -1
- package/registry/page-header.json +1 -1
- package/registry/page-hero.json +1 -1
- package/registry/page.json +1 -1
- package/registry/pagination.json +1 -1
- package/registry/pointer-light.json +1 -1
- package/registry/popover.json +1 -1
- package/registry/pricing-page.json +245 -0
- package/registry/product-page.json +319 -0
- package/registry/profile-card.json +1 -1
- package/registry/progress.json +1 -1
- package/registry/promise-card.json +1 -1
- package/registry/radio-group.json +1 -1
- package/registry/scroll-stage.json +1 -1
- package/registry/search-field.json +1 -1
- package/registry/section-backdrop.json +1 -1
- package/registry/separator.json +1 -1
- package/registry/settings-layout.json +1 -1
- package/registry/skeleton.json +1 -1
- package/registry/slider.json +1 -1
- package/registry/slot.json +1 -1
- package/registry/spinner.json +1 -1
- package/registry/split-view.json +1 -1
- package/registry/stage-banner.json +1 -1
- package/registry/stat.json +1 -1
- package/registry/status-page.json +263 -0
- package/registry/stepper.json +1 -1
- package/registry/switch.json +1 -1
- package/registry/tabs.json +1 -1
- package/registry/tag-input.json +1 -1
- package/registry/terminal-replay.json +1 -1
- package/registry/theme.json +1 -1
- package/registry/toast.json +1 -1
- package/registry/toc.json +1 -1
- package/registry/tooltip.json +1 -1
- package/registry/video-player.json +1 -1
- package/registry/video-trimmer.json +1 -1
- package/dist/chunk-NOVUREEC.js.map +0 -1
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "docs-article-page",
|
|
3
|
+
"type": "primitive",
|
|
4
|
+
"title": "Docs article page",
|
|
5
|
+
"summary": "A documentation article in the docs frame: the pages, the breadcrumb, the title with its facts, the reading column, the contents, previous and next.",
|
|
6
|
+
"description": "A documentation article in the docs frame: the pages, the breadcrumb, the title with its facts, the reading column, the contents, previous and next.",
|
|
7
|
+
"status": "beta",
|
|
8
|
+
"category": "templates",
|
|
9
|
+
"platforms": "web",
|
|
10
|
+
"whenToUse": [
|
|
11
|
+
"Guides, references, concepts.",
|
|
12
|
+
"Any page of a documentation with a list of pages."
|
|
13
|
+
],
|
|
14
|
+
"whenNotToUse": [
|
|
15
|
+
{
|
|
16
|
+
"when": "For the documentation's entry.",
|
|
17
|
+
"use": "docs-hub-page"
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"when": "For a component's generated page.",
|
|
21
|
+
"use": "component-page"
|
|
22
|
+
}
|
|
23
|
+
],
|
|
24
|
+
"bestPractices": [
|
|
25
|
+
"Keep the reading column under 46rem; headings `h2` with ids for the contents.",
|
|
26
|
+
"Say when the page was updated and how long it takes to read.",
|
|
27
|
+
"Words and content arrive as props; the motion is the platform's (`[data-reveal]`, still under reduced motion)."
|
|
28
|
+
],
|
|
29
|
+
"accessibility": {
|
|
30
|
+
"keyboard": [],
|
|
31
|
+
"notes": [
|
|
32
|
+
"The breadcrumb is a named `nav` with an ordered list; previous and next a named `nav`.",
|
|
33
|
+
"On a phone the pages fold into a disclosure; the contents become chips."
|
|
34
|
+
]
|
|
35
|
+
},
|
|
36
|
+
"related": [
|
|
37
|
+
"docs-layout",
|
|
38
|
+
"toc",
|
|
39
|
+
"docs-hub-page"
|
|
40
|
+
],
|
|
41
|
+
"web": {
|
|
42
|
+
"entry": "@krizaka/ui/docs-article-page",
|
|
43
|
+
"import": "import { DocsArticlePage } from \"@krizaka/ui/docs-article-page\";",
|
|
44
|
+
"props": [
|
|
45
|
+
{
|
|
46
|
+
"component": "DocsArticlePage",
|
|
47
|
+
"description": "A documentation article: pages · breadcrumb, title, lead, facts, the reading column · contents; previous and next.",
|
|
48
|
+
"props": [
|
|
49
|
+
{
|
|
50
|
+
"name": "sidebar",
|
|
51
|
+
"type": "ReactNode",
|
|
52
|
+
"default": null,
|
|
53
|
+
"description": "The documentation's pages (a nav of links).",
|
|
54
|
+
"required": true
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"name": "sidebarLabel",
|
|
58
|
+
"type": "string",
|
|
59
|
+
"default": null,
|
|
60
|
+
"description": "On a phone, the words that open the pages.",
|
|
61
|
+
"required": true
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"name": "title",
|
|
65
|
+
"type": "ReactNode",
|
|
66
|
+
"default": null,
|
|
67
|
+
"description": "The page's `h1`.",
|
|
68
|
+
"required": true
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"name": "breadcrumb",
|
|
72
|
+
"type": "readonly { href: string; label: string; }[]",
|
|
73
|
+
"default": null,
|
|
74
|
+
"description": "Where the page sits: `{ href, label }` from the hub down.",
|
|
75
|
+
"required": false
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"name": "breadcrumbLabel",
|
|
79
|
+
"type": "string",
|
|
80
|
+
"default": "Breadcrumb",
|
|
81
|
+
"description": "The breadcrumb's accessible name (`Breadcrumb`).",
|
|
82
|
+
"required": false
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"name": "facts",
|
|
86
|
+
"type": "readonly Fact[]",
|
|
87
|
+
"default": null,
|
|
88
|
+
"description": "Facts under the lead: updated on, reading time, the version it documents.",
|
|
89
|
+
"required": false
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"name": "lead",
|
|
93
|
+
"type": "ReactNode",
|
|
94
|
+
"default": null,
|
|
95
|
+
"description": "One or two sentences under it.",
|
|
96
|
+
"required": false
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"name": "linkAs",
|
|
100
|
+
"type": "LinkComponent",
|
|
101
|
+
"default": null,
|
|
102
|
+
"description": "The app's link component (Next's `Link`).",
|
|
103
|
+
"required": false
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"name": "pager",
|
|
107
|
+
"type": "{ previous?: { href: string; title: string; }; next?: { href: string; title: string; }; labels: { previous: string; next: string; }; } | undefined",
|
|
108
|
+
"default": null,
|
|
109
|
+
"description": "The previous and next pages, and their labels.",
|
|
110
|
+
"required": false
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
"name": "toc",
|
|
114
|
+
"type": "{ label: string; items: readonly { id: string; label: string; }[]; }",
|
|
115
|
+
"default": null,
|
|
116
|
+
"description": "The contents (its `h2`s): `{ id, label }`, and its label (`On this page`).",
|
|
117
|
+
"required": false
|
|
118
|
+
}
|
|
119
|
+
]
|
|
120
|
+
}
|
|
121
|
+
],
|
|
122
|
+
"examples": [
|
|
123
|
+
{
|
|
124
|
+
"name": "cli",
|
|
125
|
+
"title": "Orazaka's CLI",
|
|
126
|
+
"description": "An article with its pages, breadcrumb, facts, contents and pager.",
|
|
127
|
+
"template": true,
|
|
128
|
+
"path": "examples/docs-article-page/cli.tsx",
|
|
129
|
+
"module": "@krizaka/ui/registry/examples/docs-article-page/cli",
|
|
130
|
+
"code": "import { CodeBlock } from \"@krizaka/ui/code-block\";\nimport { DocsArticlePage } from \"@krizaka/ui/docs-article-page\";\n\nconst PAGES = [\"Getting started\", \"The CLI\", \"Packs & Studios\"];\n\n// TEMPLATE — a documentation article (Orazaka's CLI): the pages, where it sits, its title and facts, the reading column,\n// the contents beside it, previous and next at the foot. On a phone the pages fold above the article.\nexport default function DocsArticlePageCli() {\n return (\n <DocsArticlePage\n className=\"brand-orazaka pt-6\"\n sidebarLabel=\"Pages of the documentation\"\n sidebar={\n <nav aria-label=\"Orazaka documentation\">\n <ul className=\"flex flex-col gap-1 text-sm\">\n {PAGES.map((p, i) => (\n <li key={p}>\n <a href={`#p${i}`} aria-current={i === 1 ? \"page\" : undefined} className=\"block rounded-md px-3 py-2 text-fg-secondary no-underline hover:bg-surface-2 aria-[current=page]:bg-accent-soft aria-[current=page]:text-fg\">{p}</a>\n </li>\n ))}\n </ul>\n </nav>\n }\n breadcrumb={[{ href: \"#docs\", label: \"Docs\" }, { href: \"#orazaka\", label: \"Orazaka\" }]}\n title=\"The CLI\"\n lead=\"Install, start and develop Orazaka from one command line.\"\n facts={[{ label: \"Updated 11 Oct 2026\" }, { label: \"4 min read\" }]}\n toc={{ label: \"On this page\", items: [{ id: \"install\", label: \"Install\" }, { id: \"start\", label: \"Start\" }] }}\n pager={{ previous: { href: \"#p0\", title: \"Getting started\" }, next: { href: \"#p2\", title: \"Packs & Studios\" }, labels: { previous: \"Previous\", next: \"Next\" } }}\n >\n <h2 id=\"install\">Install</h2>\n <p>One command installs the engine, the console and the models you choose.</p>\n <CodeBlock code=\"npx orazaka install\" language=\"bash\" file=\"Terminal\" copyLabel=\"Copy\" copiedLabel=\"Copied\" />\n <h2 id=\"start\">Start</h2>\n <p>Then start it; the console opens on your machine.</p>\n </DocsArticlePage>\n );\n}\n"
|
|
131
|
+
}
|
|
132
|
+
]
|
|
133
|
+
},
|
|
134
|
+
"native": null,
|
|
135
|
+
"files": [
|
|
136
|
+
{
|
|
137
|
+
"path": "docs-article-page/docs-article-page.tsx",
|
|
138
|
+
"content": "// Server-safe. A documentation article in the docs frame (DocsLayout): the pages on the left, the breadcrumb, the\n// title, its lead and facts (updated, reading time), the reading column, the contents on the right, the previous and\n// next pages at the foot. On a phone the pages fold above the article and the contents become chips.\nimport { DocsLayout } from \"@krizaka/ui/docs-layout\";\nimport { type Fact, Facts } from \"@krizaka/ui/page\";\nimport type { LinkComponent } from \"@krizaka/ui/page-hero\";\nimport { Toc } from \"@krizaka/ui/toc\";\nimport type * as React from \"react\";\n\nexport type DocsArticlePageProps = Omit<React.HTMLAttributes<HTMLElement>, \"title\"> & {\n /** The documentation's pages (a nav of links). */\n sidebar: React.ReactNode;\n /** On a phone, the words that open the pages. */\n sidebarLabel: string;\n /** Where the page sits: `{ href, label }` from the hub down. */\n breadcrumb?: readonly { href: string; label: string }[];\n /** The breadcrumb's accessible name (`Breadcrumb`). */\n breadcrumbLabel?: string;\n /** The page's `h1`. */\n title: React.ReactNode;\n /** One or two sentences under it. */\n lead?: React.ReactNode;\n /** Facts under the lead: updated on, reading time, the version it documents. */\n facts?: readonly Fact[];\n /** The contents (its `h2`s): `{ id, label }`, and its label (`On this page`). */\n toc?: { label: string; items: readonly { id: string; label: string }[] };\n /** The previous and next pages, and their labels. */\n pager?: { previous?: { href: string; title: string }; next?: { href: string; title: string }; labels: { previous: string; next: string } };\n /** The article's body (prose, code blocks, diagrams). */\n children: React.ReactNode;\n /** The app's link component (Next's `Link`). */\n linkAs?: LinkComponent;\n};\n\n/** A documentation article: pages · breadcrumb, title, lead, facts, the reading column · contents; previous and next. */\nexport function DocsArticlePage({ sidebar, sidebarLabel, breadcrumb, breadcrumbLabel = \"Breadcrumb\", title, lead, facts, toc, pager, linkAs, children, ...props }: DocsArticlePageProps) {\n const L = (linkAs ?? \"a\") as React.ElementType;\n return (\n <DocsLayout sidebar={sidebar} sidebarLabel={sidebarLabel} toc={toc && <Toc label={toc.label} items={toc.items} />} {...props}>\n {breadcrumb && breadcrumb.length > 0 && (\n <nav aria-label={breadcrumbLabel}>\n <ol className=\"kz-tpl-crumbs\">\n {breadcrumb.map((c) => (\n <li key={c.href}>\n <L href={c.href}>{c.label}</L>\n </li>\n ))}\n </ol>\n </nav>\n )}\n <h1 className=\"kz-tpl-article-title\">{title}</h1>\n {lead && <p className=\"kz-tpl-article-lead\">{lead}</p>}\n {facts && facts.length > 0 && <Facts className=\"kz-tpl-article-meta\" items={facts} />}\n <div className=\"kz-tpl-prose\">{children}</div>\n {pager && (pager.previous || pager.next) && (\n <nav className=\"kz-tpl-pager\" aria-label={`${pager.labels.previous} · ${pager.labels.next}`}>\n {pager.previous && (\n <L href={pager.previous.href} rel=\"prev\">\n <small>{pager.labels.previous}</small>\n {pager.previous.title}\n </L>\n )}\n {pager.next && (\n <L href={pager.next.href} rel=\"next\">\n <small>{pager.labels.next}</small>\n {pager.next.title}\n </L>\n )}\n </nav>\n )}\n </DocsLayout>\n );\n}\n"
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
"path": "docs-article-page/index.ts",
|
|
142
|
+
"content": "/** @krizaka/ui/docs-article-page — `DocsArticlePage`: A documentation article: pages, breadcrumb, title, facts, reading column, contents, previous and next. Server-safe; a page template. */\nexport { DocsArticlePage, type DocsArticlePageProps } from \"./docs-article-page\";\n"
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"path": "docs-article-page/meta.ts",
|
|
146
|
+
"content": "import type { ComponentMeta } from \"../meta\";\n\nexport const meta = {\n title: \"Docs article page\",\n summary: \"A documentation article in the docs frame: the pages, the breadcrumb, the title with its facts, the reading column, the contents, previous and next.\",\n status: \"beta\",\n category: \"templates\",\n platforms: \"web\",\n whenToUse: [\"Guides, references, concepts.\", \"Any page of a documentation with a list of pages.\"],\n whenNotToUse: [\n { when: \"For the documentation's entry.\", use: \"docs-hub-page\" },\n { when: \"For a component's generated page.\", use: \"component-page\" },\n ],\n bestPractices: [\"Keep the reading column under 46rem; headings `h2` with ids for the contents.\", \"Say when the page was updated and how long it takes to read.\", \"Words and content arrive as props; the motion is the platform's (`[data-reveal]`, still under reduced motion).\"],\n accessibility: {\n keyboard: [],\n notes: [\"The breadcrumb is a named `nav` with an ordered list; previous and next a named `nav`.\", \"On a phone the pages fold into a disclosure; the contents become chips.\"],\n },\n related: [\"docs-layout\", \"toc\", \"docs-hub-page\"],\n web: {\n imports: [\"DocsArticlePage\"],\n examples: [\n { name: \"cli\", title: \"Orazaka's CLI\", description: \"An article with its pages, breadcrumb, facts, contents and pager.\", template: true },\n ],\n },\n} satisfies ComponentMeta;\n"
|
|
147
|
+
},
|
|
148
|
+
{
|
|
149
|
+
"path": "meta.ts",
|
|
150
|
+
"content": "// The documentation of a component, carried by its code: each primitive has a `meta.ts` beside its source\n// (`src/<name>/meta.ts`; a component that exists only in React Native: `src/native/meta/<name>.ts`). Never built into\n// the package: `scripts/build-registry.mjs` reads them into `registry/<name>.json`, which krizaka.com renders as\n// /docs/ui/<name>, and `scripts/registry.test.mjs` fails when one is missing or incomplete.\n//\n// Why a typed module and not JSDoc tags: the fields are lists and links (`related`, `whenNotToUse[].use`, examples),\n// which a type checks and a comment does not; the file is plain data (erasable TypeScript), so Node reads it without a\n// compiler, and an editor completes it.\n\n/** Every documented component: the web primitives (one entry of the package each) and the native-only ones. */\nexport type ComponentName =\n | \"achievement\"\n | \"action-bar\"\n | \"alert\"\n | \"app-shell\"\n | \"argument-card\"\n | \"audio-player\"\n | \"auth-layout\"\n | \"avatar\"\n | \"badge\"\n | \"button\"\n | \"card\"\n | \"card-grid\"\n | \"catalogue-page\"\n | \"changelog-page\"\n | \"checkbox\"\n | \"chip\"\n | \"chip-link\"\n | \"choice-grid\"\n | \"cn\"\n | \"code-block\"\n | \"combobox\"\n | \"command\"\n | \"component-page\"\n | \"confirm-button\"\n | \"contact-page\"\n | \"continue-prompt\"\n | \"countdown\"\n | \"cta-panel\"\n | \"dashboard-layout\"\n | \"data-table\"\n | \"date-picker\"\n | \"decision-list\"\n | \"detail-layout\"\n | \"dialog\"\n | \"docs-article-page\"\n | \"docs-hub-page\"\n | \"docs-layout\"\n | \"dropdown-menu\"\n | \"empty-state\"\n | \"error-page\"\n | \"field\"\n | \"file-upload\"\n | \"filter-bar\"\n | \"gallery-page\"\n | \"glow-card\"\n | \"goal-gauge\"\n | \"how-it-works-page\"\n | \"image-cropper\"\n | \"iso\"\n | \"kbd\"\n | \"landing-page\"\n | \"landscape\"\n | \"legal-page\"\n | \"link-card\"\n | \"loader\"\n | \"longform-page\"\n | \"marketing-layout\"\n | \"marquee\"\n | \"mascot-quote\"\n | \"mascot-state\"\n | \"mascots\"\n | \"media-capture\"\n | \"meter\"\n | \"nav-bar\"\n | \"number-ticker\"\n | \"page\"\n | \"page-header\"\n | \"page-hero\"\n | \"pagination\"\n | \"pointer-light\"\n | \"popover\"\n | \"pricing-page\"\n | \"product-page\"\n | \"profile-card\"\n | \"progress\"\n | \"promise-card\"\n | \"radio-group\"\n | \"scroll-stage\"\n | \"search-field\"\n | \"section-backdrop\"\n | \"segmented\"\n | \"separator\"\n | \"settings-layout\"\n | \"skeleton\"\n | \"slider\"\n | \"slot\"\n | \"spinner\"\n | \"split-view\"\n | \"stage-banner\"\n | \"stat\"\n | \"status-page\"\n | \"stepper\"\n | \"switch\"\n | \"tabs\"\n | \"tag-input\"\n | \"terminal-replay\"\n | \"theme\"\n | \"toast\"\n | \"toc\"\n | \"tooltip\"\n | \"txt\"\n | \"video-player\"\n | \"video-trimmer\";\n\n/** Where a component exists: `@krizaka/ui/<name>` (web), `@krizaka/ui/native` (React Native), or both. */\nexport type Platform = \"web\" | \"native\" | \"both\";\n\n/** `stable`: its API only changes in a major. `beta`: it may still change in a minor. */\nexport type Status = \"stable\" | \"beta\";\n\n/**\n * The group of the catalogue. `media`: video, sound, camera, files, cropping. `blocks`: the page blocks — the frame,\n * the hero, sections, cards that lead or argue, decisions, code, calls to act — that every page of a site is made of.\n * `layouts`: the shells of whole screens — an application, a dashboard, settings, sign-in, an object, a list and its\n * item, a site's page, a documentation page — each with its screens. `templates`: the page templates — whole pages of a\n * site (a landing, a product, a docs hub, a long read, a changelog, pricing, status, an error…), each a distinct\n * composition of the blocks, words and content as props.\n */\nexport type Category = \"actions\" | \"forms\" | \"navigation\" | \"overlays\" | \"feedback\" | \"data-display\" | \"media\" | \"blocks\" | \"layouts\" | \"templates\" | \"layout\" | \"foundations\";\n\n/**\n * A named example: the file `registry/examples/<component>/<name>.tsx` (web) or\n * `registry/examples/<component>/native/<name>.tsx` (React Native) — at most 40 lines, imported by the stories and\n * shown (live, with its code) by the documentation.\n */\nexport interface Example {\n /** The file name, kebab-case (`primary`, `icon-button`). */\n readonly name: string;\n /** A short title (`Primary`, `Icon button`). */\n readonly title: string;\n /** One or two sentences: when this variant is the right one. */\n readonly description: string;\n /**\n * A template: a whole screen of a product composed from the platform (a layout and its blocks, real words, its phone\n * version thought out), copied as a starting point — at most 160 lines, listed on krizaka.com/docs/ui/templates.\n */\n readonly template?: boolean;\n}\n\n/** One platform's side of a component. */\nexport interface PlatformDocs {\n /** The names to import (`[\"Button\", \"IconButton\"]`): from `@krizaka/ui/<name>` on the web, `@krizaka/ui/native` in React Native. */\n readonly imports: readonly string[];\n /** The examples, in reading order; the first one is the component's preview. */\n readonly examples: readonly Example[];\n}\n\n/** The React Native side: the same concept, and what differs from the web API. */\nexport interface NativeDocs extends PlatformDocs {\n /**\n * The entry to import from when it is not `@krizaka/ui/native`: a component that needs an Expo module (an optional\n * peer) has its own, `@krizaka/ui/native/<name>`, so an app that does not use it never installs the module.\n */\n readonly entry?: string;\n /** What differs from the web API (`label` instead of children…); empty for a native-only component. */\n readonly differences: readonly string[];\n}\n\nexport interface KeyboardInteraction {\n /** The keys, as written on a keyboard: `Space`, `Enter`, `Arrow keys`, `Esc`, `Tab`. */\n readonly keys: string;\n /** What they do. */\n readonly action: string;\n}\n\nexport interface ComponentMeta {\n /** The display name: `Button`, `Dropdown menu`. */\n readonly title: string;\n /** One sentence: what it is. */\n readonly summary: string;\n readonly status: Status;\n readonly category: Category;\n /** Must match the sides below: `both` ⇔ `web` and `native`. */\n readonly platforms: Platform;\n /** When to reach for it: concrete situations, one per item. */\n readonly whenToUse: readonly string[];\n /** When not to — and what to use instead (`use`), when another component is the answer. */\n readonly whenNotToUse: readonly { readonly when: string; readonly use?: ComponentName }[];\n /** How to use it well: wording, placement, composition. */\n readonly bestPractices: readonly string[];\n readonly accessibility: {\n /** The keyboard, when it does more than Tab and Enter. */\n readonly keyboard: readonly KeyboardInteraction[];\n /** Roles, names and announcements: what the component does, what the app must provide. */\n readonly notes: readonly string[];\n };\n /** The components a reader of this page should know about. */\n readonly related: readonly ComponentName[];\n readonly web?: PlatformDocs;\n readonly native?: NativeDocs;\n}\n"
|
|
151
|
+
}
|
|
152
|
+
],
|
|
153
|
+
"dependencies": [],
|
|
154
|
+
"registryDependencies": [
|
|
155
|
+
"docs-layout",
|
|
156
|
+
"page",
|
|
157
|
+
"page-hero",
|
|
158
|
+
"toc"
|
|
159
|
+
],
|
|
160
|
+
"demo": {
|
|
161
|
+
"path": "examples/docs-article-page/cli.tsx",
|
|
162
|
+
"content": "import { CodeBlock } from \"@krizaka/ui/code-block\";\nimport { DocsArticlePage } from \"@krizaka/ui/docs-article-page\";\n\nconst PAGES = [\"Getting started\", \"The CLI\", \"Packs & Studios\"];\n\n// TEMPLATE — a documentation article (Orazaka's CLI): the pages, where it sits, its title and facts, the reading column,\n// the contents beside it, previous and next at the foot. On a phone the pages fold above the article.\nexport default function DocsArticlePageCli() {\n return (\n <DocsArticlePage\n className=\"brand-orazaka pt-6\"\n sidebarLabel=\"Pages of the documentation\"\n sidebar={\n <nav aria-label=\"Orazaka documentation\">\n <ul className=\"flex flex-col gap-1 text-sm\">\n {PAGES.map((p, i) => (\n <li key={p}>\n <a href={`#p${i}`} aria-current={i === 1 ? \"page\" : undefined} className=\"block rounded-md px-3 py-2 text-fg-secondary no-underline hover:bg-surface-2 aria-[current=page]:bg-accent-soft aria-[current=page]:text-fg\">{p}</a>\n </li>\n ))}\n </ul>\n </nav>\n }\n breadcrumb={[{ href: \"#docs\", label: \"Docs\" }, { href: \"#orazaka\", label: \"Orazaka\" }]}\n title=\"The CLI\"\n lead=\"Install, start and develop Orazaka from one command line.\"\n facts={[{ label: \"Updated 11 Oct 2026\" }, { label: \"4 min read\" }]}\n toc={{ label: \"On this page\", items: [{ id: \"install\", label: \"Install\" }, { id: \"start\", label: \"Start\" }] }}\n pager={{ previous: { href: \"#p0\", title: \"Getting started\" }, next: { href: \"#p2\", title: \"Packs & Studios\" }, labels: { previous: \"Previous\", next: \"Next\" } }}\n >\n <h2 id=\"install\">Install</h2>\n <p>One command installs the engine, the console and the models you choose.</p>\n <CodeBlock code=\"npx orazaka install\" language=\"bash\" file=\"Terminal\" copyLabel=\"Copy\" copiedLabel=\"Copied\" />\n <h2 id=\"start\">Start</h2>\n <p>Then start it; the console opens on your machine.</p>\n </DocsArticlePage>\n );\n}\n"
|
|
163
|
+
},
|
|
164
|
+
"props": [
|
|
165
|
+
{
|
|
166
|
+
"component": "DocsArticlePage",
|
|
167
|
+
"description": "A documentation article: pages · breadcrumb, title, lead, facts, the reading column · contents; previous and next.",
|
|
168
|
+
"props": [
|
|
169
|
+
{
|
|
170
|
+
"name": "sidebar",
|
|
171
|
+
"type": "ReactNode",
|
|
172
|
+
"default": null,
|
|
173
|
+
"description": "The documentation's pages (a nav of links).",
|
|
174
|
+
"required": true
|
|
175
|
+
},
|
|
176
|
+
{
|
|
177
|
+
"name": "sidebarLabel",
|
|
178
|
+
"type": "string",
|
|
179
|
+
"default": null,
|
|
180
|
+
"description": "On a phone, the words that open the pages.",
|
|
181
|
+
"required": true
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"name": "title",
|
|
185
|
+
"type": "ReactNode",
|
|
186
|
+
"default": null,
|
|
187
|
+
"description": "The page's `h1`.",
|
|
188
|
+
"required": true
|
|
189
|
+
},
|
|
190
|
+
{
|
|
191
|
+
"name": "breadcrumb",
|
|
192
|
+
"type": "readonly { href: string; label: string; }[]",
|
|
193
|
+
"default": null,
|
|
194
|
+
"description": "Where the page sits: `{ href, label }` from the hub down.",
|
|
195
|
+
"required": false
|
|
196
|
+
},
|
|
197
|
+
{
|
|
198
|
+
"name": "breadcrumbLabel",
|
|
199
|
+
"type": "string",
|
|
200
|
+
"default": "Breadcrumb",
|
|
201
|
+
"description": "The breadcrumb's accessible name (`Breadcrumb`).",
|
|
202
|
+
"required": false
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"name": "facts",
|
|
206
|
+
"type": "readonly Fact[]",
|
|
207
|
+
"default": null,
|
|
208
|
+
"description": "Facts under the lead: updated on, reading time, the version it documents.",
|
|
209
|
+
"required": false
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
"name": "lead",
|
|
213
|
+
"type": "ReactNode",
|
|
214
|
+
"default": null,
|
|
215
|
+
"description": "One or two sentences under it.",
|
|
216
|
+
"required": false
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"name": "linkAs",
|
|
220
|
+
"type": "LinkComponent",
|
|
221
|
+
"default": null,
|
|
222
|
+
"description": "The app's link component (Next's `Link`).",
|
|
223
|
+
"required": false
|
|
224
|
+
},
|
|
225
|
+
{
|
|
226
|
+
"name": "pager",
|
|
227
|
+
"type": "{ previous?: { href: string; title: string; }; next?: { href: string; title: string; }; labels: { previous: string; next: string; }; } | undefined",
|
|
228
|
+
"default": null,
|
|
229
|
+
"description": "The previous and next pages, and their labels.",
|
|
230
|
+
"required": false
|
|
231
|
+
},
|
|
232
|
+
{
|
|
233
|
+
"name": "toc",
|
|
234
|
+
"type": "{ label: string; items: readonly { id: string; label: string; }[]; }",
|
|
235
|
+
"default": null,
|
|
236
|
+
"description": "The contents (its `h2`s): `{ id, label }`, and its label (`On this page`).",
|
|
237
|
+
"required": false
|
|
238
|
+
}
|
|
239
|
+
]
|
|
240
|
+
}
|
|
241
|
+
]
|
|
242
|
+
}
|
|
@@ -0,0 +1,270 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "docs-hub-page",
|
|
3
|
+
"type": "primitive",
|
|
4
|
+
"title": "Docs hub page",
|
|
5
|
+
"summary": "The entry of a documentation: the search in the middle of the hero, the collections each in its product's brand with their quick links, quick starts beside the most read pages, what is new, the owl's promise.",
|
|
6
|
+
"description": "The entry of a documentation: the search in the middle of the hero, the collections each in its product's brand with their quick links, quick starts beside the most read pages, what is new, the owl's promise.",
|
|
7
|
+
"status": "beta",
|
|
8
|
+
"category": "templates",
|
|
9
|
+
"platforms": "web",
|
|
10
|
+
"whenToUse": [
|
|
11
|
+
"The home of a documentation with several collections.",
|
|
12
|
+
"A help centre's entry."
|
|
13
|
+
],
|
|
14
|
+
"whenNotToUse": [
|
|
15
|
+
{
|
|
16
|
+
"when": "For one article of the documentation.",
|
|
17
|
+
"use": "docs-article-page"
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"when": "For a plain list of entry points.",
|
|
21
|
+
"use": "link-card"
|
|
22
|
+
}
|
|
23
|
+
],
|
|
24
|
+
"bestPractices": [
|
|
25
|
+
"The search first: most readers come to find one page.",
|
|
26
|
+
"Each collection in its product's brand, with three or four quick links.",
|
|
27
|
+
"What is new comes from the registries, never typed by hand.",
|
|
28
|
+
"Words and content arrive as props; the motion is the platform's (`[data-reveal]`, still under reduced motion)."
|
|
29
|
+
],
|
|
30
|
+
"accessibility": {
|
|
31
|
+
"keyboard": [],
|
|
32
|
+
"notes": [
|
|
33
|
+
"One `h1`; each collection a list item with its main link and a named list of quick links.",
|
|
34
|
+
"The lists of pages are lists of links with their meta in words."
|
|
35
|
+
]
|
|
36
|
+
},
|
|
37
|
+
"related": [
|
|
38
|
+
"docs-article-page",
|
|
39
|
+
"link-card",
|
|
40
|
+
"search-field"
|
|
41
|
+
],
|
|
42
|
+
"web": {
|
|
43
|
+
"entry": "@krizaka/ui/docs-hub-page",
|
|
44
|
+
"import": "import { DocsHubPage } from \"@krizaka/ui/docs-hub-page\";",
|
|
45
|
+
"props": [
|
|
46
|
+
{
|
|
47
|
+
"component": "DocsHubPage",
|
|
48
|
+
"description": "A documentation hub: search first, the collections in their brand, quick starts, popular and new pages.",
|
|
49
|
+
"props": [
|
|
50
|
+
{
|
|
51
|
+
"name": "collections",
|
|
52
|
+
"type": "readonly DocsCollection[]",
|
|
53
|
+
"default": null,
|
|
54
|
+
"description": "The collections, each in its brand.",
|
|
55
|
+
"required": true
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"name": "collectionsTitle",
|
|
59
|
+
"type": "ReactNode",
|
|
60
|
+
"default": null,
|
|
61
|
+
"description": "The collections' heading.",
|
|
62
|
+
"required": true
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"name": "title",
|
|
66
|
+
"type": "ReactNode",
|
|
67
|
+
"default": null,
|
|
68
|
+
"description": "The page's `h1`.",
|
|
69
|
+
"required": true
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"name": "eyebrow",
|
|
73
|
+
"type": "ReactNode",
|
|
74
|
+
"default": null,
|
|
75
|
+
"description": "A mono line above the title.",
|
|
76
|
+
"required": false
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"name": "lead",
|
|
80
|
+
"type": "ReactNode",
|
|
81
|
+
"default": null,
|
|
82
|
+
"description": "One sentence under it.",
|
|
83
|
+
"required": false
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"name": "linkAs",
|
|
87
|
+
"type": "LinkComponent",
|
|
88
|
+
"default": null,
|
|
89
|
+
"description": "The app's link component (Next's `Link`) for internal addresses.",
|
|
90
|
+
"required": false
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"name": "popular",
|
|
94
|
+
"type": "{ title: ReactNode; items: readonly DocsHubLink[]; }",
|
|
95
|
+
"default": null,
|
|
96
|
+
"description": "The most read pages.",
|
|
97
|
+
"required": false
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"name": "promise",
|
|
101
|
+
"type": "{ label: ReactNode; text: ReactNode; }",
|
|
102
|
+
"default": null,
|
|
103
|
+
"description": "The owl's promise at the foot: what this documentation guarantees.",
|
|
104
|
+
"required": false
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
"name": "quickstarts",
|
|
108
|
+
"type": "{ title: ReactNode; children: ReactNode; }",
|
|
109
|
+
"default": null,
|
|
110
|
+
"description": "The quick starts: a title and their samples (CodeBlocks, CodeTabs).",
|
|
111
|
+
"required": false
|
|
112
|
+
},
|
|
113
|
+
{
|
|
114
|
+
"name": "search",
|
|
115
|
+
"type": "ReactNode",
|
|
116
|
+
"default": null,
|
|
117
|
+
"description": "The search, front and centre (a SearchField, a button that opens the command palette).",
|
|
118
|
+
"required": false
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"name": "searchHints",
|
|
122
|
+
"type": "ReactNode",
|
|
123
|
+
"default": null,
|
|
124
|
+
"description": "Under the search: what people look for (a few links or keys).",
|
|
125
|
+
"required": false
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
"name": "whatsNew",
|
|
129
|
+
"type": "{ title: ReactNode; items: readonly DocsHubLink[]; }",
|
|
130
|
+
"default": null,
|
|
131
|
+
"description": "What is new (releases from the registries, published pages).",
|
|
132
|
+
"required": false
|
|
133
|
+
}
|
|
134
|
+
]
|
|
135
|
+
}
|
|
136
|
+
],
|
|
137
|
+
"examples": [
|
|
138
|
+
{
|
|
139
|
+
"name": "krizaka",
|
|
140
|
+
"title": "krizaka.com/docs",
|
|
141
|
+
"description": "The five collections, a quick start, the most read pages, what is new.",
|
|
142
|
+
"template": true,
|
|
143
|
+
"path": "examples/docs-hub-page/krizaka.tsx",
|
|
144
|
+
"module": "@krizaka/ui/registry/examples/docs-hub-page/krizaka",
|
|
145
|
+
"code": "import { ProductLogo } from \"@krizaka/ui\";\nimport { Button } from \"@krizaka/ui/button\";\nimport { CodeBlock } from \"@krizaka/ui/code-block\";\nimport { DocsHubPage } from \"@krizaka/ui/docs-hub-page\";\nimport { Kbd } from \"@krizaka/ui/kbd\";\n\nconst COLLECTIONS = [\n { id: \"ui\", title: \"Krizaka UI\", href: \"#ui\", mark: <ProductLogo id=\"krizaka\" size={26} animated={false} />, description: \"Tokens, a Tailwind preset, the components — live, generated from their code.\", links: [{ href: \"#blocks\", label: \"Blocks\" }, { href: \"#layouts\", label: \"Layouts\" }, { href: \"#templates\", label: \"Templates\" }] },\n { id: \"java\", title: \"Krizaka Java\", href: \"#java\", mark: <ProductLogo id=\"krizaka\" size={26} animated={false} />, description: \"Parent, BOM, starters, messaging, Problem Details.\", links: [{ href: \"#bom\", label: \"BOM\" }, { href: \"#messaging\", label: \"Messaging\" }] },\n { id: \"orazaka\", brand: \"orazaka\", title: \"Orazaka\", href: \"#orazaka\", mark: <ProductLogo id=\"orazaka\" size={26} animated={false} />, description: \"The sovereign AI engine: install, packs, administration.\", links: [{ href: \"#cli\", label: \"CLI\" }, { href: \"#packs\", label: \"Packs\" }, { href: \"#admin\", label: \"Admin\" }] },\n { id: \"orochia\", brand: \"orochia\", title: \"Orochia\", href: \"#orochia\", mark: <ProductLogo id=\"orochia\" size={26} animated={false} />, description: \"The creator platform: payments, auctions, the admin console.\", links: [{ href: \"#payouts\", label: \"Payouts\" }, { href: \"#console\", label: \"Console\" }] },\n];\n\n// TEMPLATE — krizaka.com/docs: the search in the middle of the hero (⌘K), the collections each in its product's brand\n// with their quick links, a quick start beside the most read pages, what is new, the owl's promise. On a phone: search,\n// then one collection per row.\nexport default function DocsHubPageKrizaka() {\n return (\n <DocsHubPage\n eyebrow=\"Documentation\"\n title=\"Build with Krizaka\"\n lead=\"Every building block the products are made of, documented from its source.\"\n search={\n <Button variant=\"secondary\" size=\"lg\" shape=\"cut\" className=\"w-full justify-between text-fg-secondary\">\n Search the documentation <Kbd>⌘K</Kbd>\n </Button>\n }\n searchHints={<>Try: <a href=\"#cli\">orazaka install</a> · <a href=\"#button\">Button</a> · <a href=\"#bom\">BOM</a></>}\n collectionsTitle=\"Collections\"\n collections={COLLECTIONS}\n quickstarts={{ title: \"Start in one line\", children: <CodeBlock code=\"npx orazaka install\" language=\"bash\" file=\"Terminal\" copyLabel=\"Copy\" copiedLabel=\"Copied\" /> }}\n popular={{ title: \"Most read\", items: [{ href: \"#cli\", title: \"The CLI\", meta: \"Orazaka\" }, { href: \"#button\", title: \"Button\", meta: \"Krizaka UI\" }, { href: \"#bom\", title: \"The BOM\", meta: \"Java\" }] }}\n whatsNew={{ title: \"What's new\", items: [{ href: \"#ui-260\", title: \"Page blocks: frame, hero, cards, decisions\", meta: \"@krizaka/ui 2.6.0\" }, { href: \"#java-010\", title: \"The platform kit on Maven Central\", meta: \"0.1.0\" }] }}\n promise={{ label: \"The owl's promise\", text: \"Every page here is generated from the code it documents — when the code changes, the page does.\" }}\n />\n );\n}\n"
|
|
146
|
+
}
|
|
147
|
+
]
|
|
148
|
+
},
|
|
149
|
+
"native": null,
|
|
150
|
+
"files": [
|
|
151
|
+
{
|
|
152
|
+
"path": "docs-hub-page/docs-hub-page.tsx",
|
|
153
|
+
"content": "// Server-safe. The entry of a documentation (blocks.css `.kz-tpl-hub-*`, `.kz-tpl-collections`): the search in the\n// middle of the hero, the collections each in its product's brand with its quick links, the quick starts beside the\n// most read pages, what is new from the registries, and the owl's promise. One column on a phone, the search first.\nimport { MascotQuote } from \"@krizaka/ui/mascot-quote\";\nimport { Section } from \"@krizaka/ui/page\";\nimport type { LinkComponent } from \"@krizaka/ui/page-hero\";\nimport { PageHero } from \"@krizaka/ui/page-hero\";\nimport * as React from \"react\";\n\nexport interface DocsCollection {\n /** A stable key. */\n id: string;\n /** The product's brand (`orazaka`…): the panel wears `.brand-<id>`. */\n brand?: string;\n /** The product's mark. */\n mark?: React.ReactNode;\n /** The collection's name: a link to its home. */\n title: string;\n /** Where it starts. */\n href: string;\n /** What it covers, in one sentence. */\n description?: React.ReactNode;\n /** Its most useful pages (three or four). */\n links?: readonly { href: string; label: string }[];\n}\n\nexport interface DocsHubLink {\n /** Where it leads. */\n href: string;\n /** The page's title. */\n title: React.ReactNode;\n /** On the right, in mono: a collection, a version, a date. */\n meta?: React.ReactNode;\n}\n\nexport type DocsHubPageProps = Omit<React.HTMLAttributes<HTMLElement>, \"title\"> & {\n /** A mono line above the title. */\n eyebrow?: React.ReactNode;\n /** The page's `h1`. */\n title: React.ReactNode;\n /** One sentence under it. */\n lead?: React.ReactNode;\n /** The search, front and centre (a SearchField, a button that opens the command palette). */\n search?: React.ReactNode;\n /** Under the search: what people look for (a few links or keys). */\n searchHints?: React.ReactNode;\n /** The collections' heading. */\n collectionsTitle: React.ReactNode;\n /** The collections, each in its brand. */\n collections: readonly DocsCollection[];\n /** The quick starts: a title and their samples (CodeBlocks, CodeTabs). */\n quickstarts?: { title: React.ReactNode; children: React.ReactNode };\n /** The most read pages. */\n popular?: { title: React.ReactNode; items: readonly DocsHubLink[] };\n /** What is new (releases from the registries, published pages). */\n whatsNew?: { title: React.ReactNode; items: readonly DocsHubLink[] };\n /** The owl's promise at the foot: what this documentation guarantees. */\n promise?: { label: React.ReactNode; text: React.ReactNode };\n /** The app's link component (Next's `Link`) for internal addresses. */\n linkAs?: LinkComponent;\n};\n\nfunction List({ items, linkAs: Link = \"a\" }: { items: readonly DocsHubLink[]; linkAs?: LinkComponent }) {\n const L = Link as React.ElementType;\n return (\n <ul className=\"kz-tpl-links\">\n {items.map((item, i) => (\n <li key={`${i}:${item.href}`}>\n <L href={item.href}>\n <strong>{item.title}</strong>\n {item.meta && <small>{item.meta}</small>}\n </L>\n </li>\n ))}\n </ul>\n );\n}\n\n/** A documentation hub: search first, the collections in their brand, quick starts, popular and new pages. */\nexport function DocsHubPage({ eyebrow, title, lead, search, searchHints, collectionsTitle, collections, quickstarts, popular, whatsNew, promise, linkAs, ...props }: DocsHubPageProps) {\n const L = (linkAs ?? \"a\") as React.ElementType;\n return (\n <div {...props}>\n <PageHero eyebrow={eyebrow} title={title} lead={lead} align=\"center\" backdrop=\"grid\">\n {(search || searchHints) && (\n <div className=\"kz-tpl-hub-search\">\n {search}\n {searchHints && <div className=\"kz-tpl-hub-hints\">{searchHints}</div>}\n </div>\n )}\n </PageHero>\n <Section id=\"collections\" title={collectionsTitle} headingSize=\"sm\" spacing=\"sm\">\n <ul className=\"kz-tpl-collections\">\n {collections.map((c) => (\n <li key={c.id} className={c.brand ? \"brand-\" + c.brand : undefined}>\n <div className=\"kz-tpl-collection\">\n <div className=\"kz-tpl-collection-head\">\n {c.mark && <span aria-hidden>{c.mark}</span>}\n <L href={c.href}>{c.title}</L>\n </div>\n {c.description && <p>{c.description}</p>}\n {c.links && c.links.length > 0 && (\n <ul aria-label={c.title}>\n {c.links.map((l) => (\n <li key={l.href}>\n <L href={l.href}>{l.label}</L>\n </li>\n ))}\n </ul>\n )}\n </div>\n </li>\n ))}\n </ul>\n </Section>\n {(quickstarts || popular) && (\n <Section spacing=\"sm\" divider aria-label={typeof quickstarts?.title === \"string\" ? quickstarts.title : undefined}>\n <div className=\"kz-tpl-two\">\n {quickstarts && (\n <div className=\"kz-tpl-stack\">\n <h2 className=\"kz-heading-title kz-tpl-h2\">{quickstarts.title}</h2>\n {quickstarts.children}\n </div>\n )}\n {popular && (\n <div className=\"kz-tpl-stack\">\n <h2 className=\"kz-heading-title kz-tpl-h2\">{popular.title}</h2>\n <List items={popular.items} linkAs={linkAs} />\n </div>\n )}\n </div>\n </Section>\n )}\n {whatsNew && (\n <Section id=\"whats-new\" title={whatsNew.title} headingSize=\"sm\" spacing=\"sm\" divider>\n <List items={whatsNew.items} linkAs={linkAs} />\n </Section>\n )}\n {promise && (\n <Section spacing=\"sm\" aria-label={typeof promise.label === \"string\" ? promise.label : undefined}>\n <MascotQuote variant=\"callout\" bird=\"owl\" mood=\"welcome\" label={promise.label}>\n {promise.text}\n </MascotQuote>\n </Section>\n )}\n </div>\n );\n}\n"
|
|
154
|
+
},
|
|
155
|
+
{
|
|
156
|
+
"path": "docs-hub-page/index.ts",
|
|
157
|
+
"content": "/** @krizaka/ui/docs-hub-page — `DocsHubPage`: A documentation hub: search first, the collections in their brand, quick starts, popular and new pages. Server-safe; a page template. */\nexport { type DocsCollection, type DocsHubLink,DocsHubPage, type DocsHubPageProps } from \"./docs-hub-page\";\n"
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
"path": "docs-hub-page/meta.ts",
|
|
161
|
+
"content": "import type { ComponentMeta } from \"../meta\";\n\nexport const meta = {\n title: \"Docs hub page\",\n summary: \"The entry of a documentation: the search in the middle of the hero, the collections each in its product's brand with their quick links, quick starts beside the most read pages, what is new, the owl's promise.\",\n status: \"beta\",\n category: \"templates\",\n platforms: \"web\",\n whenToUse: [\"The home of a documentation with several collections.\", \"A help centre's entry.\"],\n whenNotToUse: [\n { when: \"For one article of the documentation.\", use: \"docs-article-page\" },\n { when: \"For a plain list of entry points.\", use: \"link-card\" },\n ],\n bestPractices: [\"The search first: most readers come to find one page.\", \"Each collection in its product's brand, with three or four quick links.\", \"What is new comes from the registries, never typed by hand.\", \"Words and content arrive as props; the motion is the platform's (`[data-reveal]`, still under reduced motion).\"],\n accessibility: {\n keyboard: [],\n notes: [\"One `h1`; each collection a list item with its main link and a named list of quick links.\", \"The lists of pages are lists of links with their meta in words.\"],\n },\n related: [\"docs-article-page\", \"link-card\", \"search-field\"],\n web: {\n imports: [\"DocsHubPage\"],\n examples: [\n { name: \"krizaka\", title: \"krizaka.com/docs\", description: \"The five collections, a quick start, the most read pages, what is new.\", template: true },\n ],\n },\n} satisfies ComponentMeta;\n"
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
"path": "meta.ts",
|
|
165
|
+
"content": "// The documentation of a component, carried by its code: each primitive has a `meta.ts` beside its source\n// (`src/<name>/meta.ts`; a component that exists only in React Native: `src/native/meta/<name>.ts`). Never built into\n// the package: `scripts/build-registry.mjs` reads them into `registry/<name>.json`, which krizaka.com renders as\n// /docs/ui/<name>, and `scripts/registry.test.mjs` fails when one is missing or incomplete.\n//\n// Why a typed module and not JSDoc tags: the fields are lists and links (`related`, `whenNotToUse[].use`, examples),\n// which a type checks and a comment does not; the file is plain data (erasable TypeScript), so Node reads it without a\n// compiler, and an editor completes it.\n\n/** Every documented component: the web primitives (one entry of the package each) and the native-only ones. */\nexport type ComponentName =\n | \"achievement\"\n | \"action-bar\"\n | \"alert\"\n | \"app-shell\"\n | \"argument-card\"\n | \"audio-player\"\n | \"auth-layout\"\n | \"avatar\"\n | \"badge\"\n | \"button\"\n | \"card\"\n | \"card-grid\"\n | \"catalogue-page\"\n | \"changelog-page\"\n | \"checkbox\"\n | \"chip\"\n | \"chip-link\"\n | \"choice-grid\"\n | \"cn\"\n | \"code-block\"\n | \"combobox\"\n | \"command\"\n | \"component-page\"\n | \"confirm-button\"\n | \"contact-page\"\n | \"continue-prompt\"\n | \"countdown\"\n | \"cta-panel\"\n | \"dashboard-layout\"\n | \"data-table\"\n | \"date-picker\"\n | \"decision-list\"\n | \"detail-layout\"\n | \"dialog\"\n | \"docs-article-page\"\n | \"docs-hub-page\"\n | \"docs-layout\"\n | \"dropdown-menu\"\n | \"empty-state\"\n | \"error-page\"\n | \"field\"\n | \"file-upload\"\n | \"filter-bar\"\n | \"gallery-page\"\n | \"glow-card\"\n | \"goal-gauge\"\n | \"how-it-works-page\"\n | \"image-cropper\"\n | \"iso\"\n | \"kbd\"\n | \"landing-page\"\n | \"landscape\"\n | \"legal-page\"\n | \"link-card\"\n | \"loader\"\n | \"longform-page\"\n | \"marketing-layout\"\n | \"marquee\"\n | \"mascot-quote\"\n | \"mascot-state\"\n | \"mascots\"\n | \"media-capture\"\n | \"meter\"\n | \"nav-bar\"\n | \"number-ticker\"\n | \"page\"\n | \"page-header\"\n | \"page-hero\"\n | \"pagination\"\n | \"pointer-light\"\n | \"popover\"\n | \"pricing-page\"\n | \"product-page\"\n | \"profile-card\"\n | \"progress\"\n | \"promise-card\"\n | \"radio-group\"\n | \"scroll-stage\"\n | \"search-field\"\n | \"section-backdrop\"\n | \"segmented\"\n | \"separator\"\n | \"settings-layout\"\n | \"skeleton\"\n | \"slider\"\n | \"slot\"\n | \"spinner\"\n | \"split-view\"\n | \"stage-banner\"\n | \"stat\"\n | \"status-page\"\n | \"stepper\"\n | \"switch\"\n | \"tabs\"\n | \"tag-input\"\n | \"terminal-replay\"\n | \"theme\"\n | \"toast\"\n | \"toc\"\n | \"tooltip\"\n | \"txt\"\n | \"video-player\"\n | \"video-trimmer\";\n\n/** Where a component exists: `@krizaka/ui/<name>` (web), `@krizaka/ui/native` (React Native), or both. */\nexport type Platform = \"web\" | \"native\" | \"both\";\n\n/** `stable`: its API only changes in a major. `beta`: it may still change in a minor. */\nexport type Status = \"stable\" | \"beta\";\n\n/**\n * The group of the catalogue. `media`: video, sound, camera, files, cropping. `blocks`: the page blocks — the frame,\n * the hero, sections, cards that lead or argue, decisions, code, calls to act — that every page of a site is made of.\n * `layouts`: the shells of whole screens — an application, a dashboard, settings, sign-in, an object, a list and its\n * item, a site's page, a documentation page — each with its screens. `templates`: the page templates — whole pages of a\n * site (a landing, a product, a docs hub, a long read, a changelog, pricing, status, an error…), each a distinct\n * composition of the blocks, words and content as props.\n */\nexport type Category = \"actions\" | \"forms\" | \"navigation\" | \"overlays\" | \"feedback\" | \"data-display\" | \"media\" | \"blocks\" | \"layouts\" | \"templates\" | \"layout\" | \"foundations\";\n\n/**\n * A named example: the file `registry/examples/<component>/<name>.tsx` (web) or\n * `registry/examples/<component>/native/<name>.tsx` (React Native) — at most 40 lines, imported by the stories and\n * shown (live, with its code) by the documentation.\n */\nexport interface Example {\n /** The file name, kebab-case (`primary`, `icon-button`). */\n readonly name: string;\n /** A short title (`Primary`, `Icon button`). */\n readonly title: string;\n /** One or two sentences: when this variant is the right one. */\n readonly description: string;\n /**\n * A template: a whole screen of a product composed from the platform (a layout and its blocks, real words, its phone\n * version thought out), copied as a starting point — at most 160 lines, listed on krizaka.com/docs/ui/templates.\n */\n readonly template?: boolean;\n}\n\n/** One platform's side of a component. */\nexport interface PlatformDocs {\n /** The names to import (`[\"Button\", \"IconButton\"]`): from `@krizaka/ui/<name>` on the web, `@krizaka/ui/native` in React Native. */\n readonly imports: readonly string[];\n /** The examples, in reading order; the first one is the component's preview. */\n readonly examples: readonly Example[];\n}\n\n/** The React Native side: the same concept, and what differs from the web API. */\nexport interface NativeDocs extends PlatformDocs {\n /**\n * The entry to import from when it is not `@krizaka/ui/native`: a component that needs an Expo module (an optional\n * peer) has its own, `@krizaka/ui/native/<name>`, so an app that does not use it never installs the module.\n */\n readonly entry?: string;\n /** What differs from the web API (`label` instead of children…); empty for a native-only component. */\n readonly differences: readonly string[];\n}\n\nexport interface KeyboardInteraction {\n /** The keys, as written on a keyboard: `Space`, `Enter`, `Arrow keys`, `Esc`, `Tab`. */\n readonly keys: string;\n /** What they do. */\n readonly action: string;\n}\n\nexport interface ComponentMeta {\n /** The display name: `Button`, `Dropdown menu`. */\n readonly title: string;\n /** One sentence: what it is. */\n readonly summary: string;\n readonly status: Status;\n readonly category: Category;\n /** Must match the sides below: `both` ⇔ `web` and `native`. */\n readonly platforms: Platform;\n /** When to reach for it: concrete situations, one per item. */\n readonly whenToUse: readonly string[];\n /** When not to — and what to use instead (`use`), when another component is the answer. */\n readonly whenNotToUse: readonly { readonly when: string; readonly use?: ComponentName }[];\n /** How to use it well: wording, placement, composition. */\n readonly bestPractices: readonly string[];\n readonly accessibility: {\n /** The keyboard, when it does more than Tab and Enter. */\n readonly keyboard: readonly KeyboardInteraction[];\n /** Roles, names and announcements: what the component does, what the app must provide. */\n readonly notes: readonly string[];\n };\n /** The components a reader of this page should know about. */\n readonly related: readonly ComponentName[];\n readonly web?: PlatformDocs;\n readonly native?: NativeDocs;\n}\n"
|
|
166
|
+
}
|
|
167
|
+
],
|
|
168
|
+
"dependencies": [],
|
|
169
|
+
"registryDependencies": [
|
|
170
|
+
"mascot-quote",
|
|
171
|
+
"page",
|
|
172
|
+
"page-hero"
|
|
173
|
+
],
|
|
174
|
+
"demo": {
|
|
175
|
+
"path": "examples/docs-hub-page/krizaka.tsx",
|
|
176
|
+
"content": "import { ProductLogo } from \"@krizaka/ui\";\nimport { Button } from \"@krizaka/ui/button\";\nimport { CodeBlock } from \"@krizaka/ui/code-block\";\nimport { DocsHubPage } from \"@krizaka/ui/docs-hub-page\";\nimport { Kbd } from \"@krizaka/ui/kbd\";\n\nconst COLLECTIONS = [\n { id: \"ui\", title: \"Krizaka UI\", href: \"#ui\", mark: <ProductLogo id=\"krizaka\" size={26} animated={false} />, description: \"Tokens, a Tailwind preset, the components — live, generated from their code.\", links: [{ href: \"#blocks\", label: \"Blocks\" }, { href: \"#layouts\", label: \"Layouts\" }, { href: \"#templates\", label: \"Templates\" }] },\n { id: \"java\", title: \"Krizaka Java\", href: \"#java\", mark: <ProductLogo id=\"krizaka\" size={26} animated={false} />, description: \"Parent, BOM, starters, messaging, Problem Details.\", links: [{ href: \"#bom\", label: \"BOM\" }, { href: \"#messaging\", label: \"Messaging\" }] },\n { id: \"orazaka\", brand: \"orazaka\", title: \"Orazaka\", href: \"#orazaka\", mark: <ProductLogo id=\"orazaka\" size={26} animated={false} />, description: \"The sovereign AI engine: install, packs, administration.\", links: [{ href: \"#cli\", label: \"CLI\" }, { href: \"#packs\", label: \"Packs\" }, { href: \"#admin\", label: \"Admin\" }] },\n { id: \"orochia\", brand: \"orochia\", title: \"Orochia\", href: \"#orochia\", mark: <ProductLogo id=\"orochia\" size={26} animated={false} />, description: \"The creator platform: payments, auctions, the admin console.\", links: [{ href: \"#payouts\", label: \"Payouts\" }, { href: \"#console\", label: \"Console\" }] },\n];\n\n// TEMPLATE — krizaka.com/docs: the search in the middle of the hero (⌘K), the collections each in its product's brand\n// with their quick links, a quick start beside the most read pages, what is new, the owl's promise. On a phone: search,\n// then one collection per row.\nexport default function DocsHubPageKrizaka() {\n return (\n <DocsHubPage\n eyebrow=\"Documentation\"\n title=\"Build with Krizaka\"\n lead=\"Every building block the products are made of, documented from its source.\"\n search={\n <Button variant=\"secondary\" size=\"lg\" shape=\"cut\" className=\"w-full justify-between text-fg-secondary\">\n Search the documentation <Kbd>⌘K</Kbd>\n </Button>\n }\n searchHints={<>Try: <a href=\"#cli\">orazaka install</a> · <a href=\"#button\">Button</a> · <a href=\"#bom\">BOM</a></>}\n collectionsTitle=\"Collections\"\n collections={COLLECTIONS}\n quickstarts={{ title: \"Start in one line\", children: <CodeBlock code=\"npx orazaka install\" language=\"bash\" file=\"Terminal\" copyLabel=\"Copy\" copiedLabel=\"Copied\" /> }}\n popular={{ title: \"Most read\", items: [{ href: \"#cli\", title: \"The CLI\", meta: \"Orazaka\" }, { href: \"#button\", title: \"Button\", meta: \"Krizaka UI\" }, { href: \"#bom\", title: \"The BOM\", meta: \"Java\" }] }}\n whatsNew={{ title: \"What's new\", items: [{ href: \"#ui-260\", title: \"Page blocks: frame, hero, cards, decisions\", meta: \"@krizaka/ui 2.6.0\" }, { href: \"#java-010\", title: \"The platform kit on Maven Central\", meta: \"0.1.0\" }] }}\n promise={{ label: \"The owl's promise\", text: \"Every page here is generated from the code it documents — when the code changes, the page does.\" }}\n />\n );\n}\n"
|
|
177
|
+
},
|
|
178
|
+
"props": [
|
|
179
|
+
{
|
|
180
|
+
"component": "DocsHubPage",
|
|
181
|
+
"description": "A documentation hub: search first, the collections in their brand, quick starts, popular and new pages.",
|
|
182
|
+
"props": [
|
|
183
|
+
{
|
|
184
|
+
"name": "collections",
|
|
185
|
+
"type": "readonly DocsCollection[]",
|
|
186
|
+
"default": null,
|
|
187
|
+
"description": "The collections, each in its brand.",
|
|
188
|
+
"required": true
|
|
189
|
+
},
|
|
190
|
+
{
|
|
191
|
+
"name": "collectionsTitle",
|
|
192
|
+
"type": "ReactNode",
|
|
193
|
+
"default": null,
|
|
194
|
+
"description": "The collections' heading.",
|
|
195
|
+
"required": true
|
|
196
|
+
},
|
|
197
|
+
{
|
|
198
|
+
"name": "title",
|
|
199
|
+
"type": "ReactNode",
|
|
200
|
+
"default": null,
|
|
201
|
+
"description": "The page's `h1`.",
|
|
202
|
+
"required": true
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"name": "eyebrow",
|
|
206
|
+
"type": "ReactNode",
|
|
207
|
+
"default": null,
|
|
208
|
+
"description": "A mono line above the title.",
|
|
209
|
+
"required": false
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
"name": "lead",
|
|
213
|
+
"type": "ReactNode",
|
|
214
|
+
"default": null,
|
|
215
|
+
"description": "One sentence under it.",
|
|
216
|
+
"required": false
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"name": "linkAs",
|
|
220
|
+
"type": "LinkComponent",
|
|
221
|
+
"default": null,
|
|
222
|
+
"description": "The app's link component (Next's `Link`) for internal addresses.",
|
|
223
|
+
"required": false
|
|
224
|
+
},
|
|
225
|
+
{
|
|
226
|
+
"name": "popular",
|
|
227
|
+
"type": "{ title: ReactNode; items: readonly DocsHubLink[]; }",
|
|
228
|
+
"default": null,
|
|
229
|
+
"description": "The most read pages.",
|
|
230
|
+
"required": false
|
|
231
|
+
},
|
|
232
|
+
{
|
|
233
|
+
"name": "promise",
|
|
234
|
+
"type": "{ label: ReactNode; text: ReactNode; }",
|
|
235
|
+
"default": null,
|
|
236
|
+
"description": "The owl's promise at the foot: what this documentation guarantees.",
|
|
237
|
+
"required": false
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"name": "quickstarts",
|
|
241
|
+
"type": "{ title: ReactNode; children: ReactNode; }",
|
|
242
|
+
"default": null,
|
|
243
|
+
"description": "The quick starts: a title and their samples (CodeBlocks, CodeTabs).",
|
|
244
|
+
"required": false
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
"name": "search",
|
|
248
|
+
"type": "ReactNode",
|
|
249
|
+
"default": null,
|
|
250
|
+
"description": "The search, front and centre (a SearchField, a button that opens the command palette).",
|
|
251
|
+
"required": false
|
|
252
|
+
},
|
|
253
|
+
{
|
|
254
|
+
"name": "searchHints",
|
|
255
|
+
"type": "ReactNode",
|
|
256
|
+
"default": null,
|
|
257
|
+
"description": "Under the search: what people look for (a few links or keys).",
|
|
258
|
+
"required": false
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
"name": "whatsNew",
|
|
262
|
+
"type": "{ title: ReactNode; items: readonly DocsHubLink[]; }",
|
|
263
|
+
"default": null,
|
|
264
|
+
"description": "What is new (releases from the registries, published pages).",
|
|
265
|
+
"required": false
|
|
266
|
+
}
|
|
267
|
+
]
|
|
268
|
+
}
|
|
269
|
+
]
|
|
270
|
+
}
|