kitfly 0.1.2 → 0.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/CHANGELOG.md +46 -0
- package/README.md +63 -16
- package/VERSION +1 -1
- package/dist/_raw/content/deployment/preflight.md +134 -0
- package/dist/_raw/content/deployment/recipes/aws-s3.md +128 -0
- package/dist/_raw/content/deployment/recipes/cloudflare-pages.md +73 -0
- package/dist/_raw/content/deployment/recipes/cloudflare-r2.md +156 -0
- package/dist/_raw/content/deployment/recipes/fly-io.md +57 -0
- package/dist/_raw/content/deployment/recipes/github-pages.md +112 -0
- package/dist/_raw/content/deployment/recipes/netlify.md +99 -0
- package/dist/_raw/content/deployment/recipes/vercel.md +88 -0
- package/dist/_raw/content/deployment/secrets-and-env-vars.md +75 -0
- package/dist/_raw/content/deployment.md +128 -0
- package/dist/_raw/content/guide/approaches.md +182 -0
- package/dist/_raw/content/guide/features.md +121 -0
- package/dist/_raw/content/guide/getting-started.md +112 -0
- package/dist/_raw/content/guide/kitfly-overview.md +209 -0
- package/dist/_raw/content/reference/configuration.md +259 -0
- package/dist/_raw/content/reference/design-catalog.md +167 -0
- package/dist/_raw/content/reference/environment-variables.md +66 -0
- package/dist/_raw/content/reference/glossary.md +92 -0
- package/dist/_raw/content/reference/key-concepts.md +118 -0
- package/dist/_raw/content/reference/plugins.md +220 -0
- package/dist/_raw/content/reference/slides-authoring-guidelines.md +129 -0
- package/dist/_raw/content/reference/structure.md +166 -0
- package/dist/_raw/content/reference.md +20 -0
- package/dist/_raw/content/templates/crucible.md +192 -0
- package/dist/_raw/content/templates/handbook.md +83 -0
- package/dist/_raw/content/templates/minimal.md +138 -0
- package/dist/_raw/content/templates/overview.md +187 -0
- package/dist/_raw/content/templates/pipeline.md +151 -0
- package/dist/_raw/content/templates/productbook.md +187 -0
- package/dist/_raw/content/templates/runbook.md +193 -0
- package/dist/_raw/content/templates/servicebook.md +163 -0
- package/dist/_raw/docs/decisions/ADR-0001-minimalist-site-code.md +118 -0
- package/dist/_raw/docs/decisions/ADR-0002-ai-accessibility.md +153 -0
- package/dist/_raw/docs/decisions/ADR-0003-single-file-bundle.md +93 -0
- package/dist/_raw/docs/decisions/ADR-0004-bun-runtime.md +98 -0
- package/dist/_raw/docs/decisions/ADR-0005-plugin-contract-and-distribution.md +110 -0
- package/dist/_raw/docs/decisions/DDR-0001-viewport-locked-layout.md +111 -0
- package/dist/_raw/docs/decisions/DDR-0002-theme-system.md +131 -0
- package/dist/_raw/docs/decisions/DDR-0003-bounded-logo-slot.md +106 -0
- package/dist/_raw/docs/decisions/DDR-0004-slides-rendering-model.md +113 -0
- package/dist/_raw/docs/decisions/DDR-0005-deterministic-layout-boundary.md +107 -0
- package/dist/_raw/docs/userguide/cli/build.md +85 -0
- package/dist/_raw/docs/userguide/cli/bundle.md +81 -0
- package/dist/_raw/docs/userguide/cli/dev.md +92 -0
- package/dist/_raw/docs/userguide/cli/init.md +116 -0
- package/dist/_raw/docs/userguide/cli/servers.md +69 -0
- package/dist/_raw/docs/userguide/cli/stop.md +76 -0
- package/dist/_raw/docs/userguide/cli/update.md +78 -0
- package/dist/_raw/docs/userguide/cli/version.md +65 -0
- package/dist/_raw/docs/userguide/cli.md +34 -0
- package/dist/_raw/docs/userguide/sharing.md +94 -0
- package/dist/_raw/schemas/plugin-schemas-notes.md +71 -0
- package/dist/_raw/schemas.md +42 -0
- package/dist/assets/brand/kitfly-favicon-32.png +0 -0
- package/dist/assets/brand/kitfly-icon-64.png +0 -0
- package/dist/assets/brand/kitfly-logo-128.png +0 -0
- package/dist/assets/brand/kitfly-logo-512.png +0 -0
- package/dist/assets/brand/kitfly-logo.svg +12132 -0
- package/dist/assets/brand/kitfly-neon-128.png +0 -0
- package/dist/assets/brand/kitfly-neon-192.png +0 -0
- package/dist/assets/brand/kitfly-neon-256.png +0 -0
- package/dist/assets/brand/kitfly-neon.png +0 -0
- package/dist/assets/brand/palette.md +75 -0
- package/dist/content/deployment/index.html +11 -0
- package/dist/content/deployment/preflight.html +418 -0
- package/dist/content/deployment/recipes/aws-s3.html +421 -0
- package/dist/content/deployment/recipes/cloudflare-pages.html +372 -0
- package/dist/content/deployment/recipes/cloudflare-r2.html +443 -0
- package/dist/content/deployment/recipes/fly-io.html +356 -0
- package/dist/content/deployment/recipes/github-pages.html +414 -0
- package/dist/content/deployment/recipes/index.html +11 -0
- package/dist/content/deployment/recipes/netlify.html +394 -0
- package/dist/content/deployment/recipes/vercel.html +382 -0
- package/dist/content/deployment/secrets-and-env-vars.html +380 -0
- package/dist/content/deployment.html +426 -0
- package/dist/content/guide/approaches.html +501 -0
- package/dist/content/guide/features.html +436 -0
- package/dist/content/guide/getting-started.html +403 -0
- package/dist/content/guide/index.html +11 -0
- package/dist/content/guide/kitfly-overview.html +544 -0
- package/dist/content/index.html +11 -0
- package/dist/content/reference/configuration.html +580 -0
- package/dist/content/reference/design-catalog.html +449 -0
- package/dist/content/reference/environment-variables.html +367 -0
- package/dist/content/reference/glossary.html +368 -0
- package/dist/content/reference/index.html +11 -0
- package/dist/content/reference/key-concepts.html +399 -0
- package/dist/content/reference/plugins.html +491 -0
- package/dist/content/reference/slides-authoring-guidelines.html +418 -0
- package/dist/content/reference/structure.html +463 -0
- package/dist/content/reference.html +335 -0
- package/dist/content/templates/crucible.html +546 -0
- package/dist/content/templates/handbook.html +405 -0
- package/dist/content/templates/index.html +11 -0
- package/dist/content/templates/minimal.html +447 -0
- package/dist/content/templates/overview.html +558 -0
- package/dist/content/templates/pipeline.html +494 -0
- package/dist/content/templates/productbook.html +540 -0
- package/dist/content/templates/runbook.html +543 -0
- package/dist/content/templates/servicebook.html +523 -0
- package/dist/content-index.json +549 -0
- package/dist/docs/decisions/ADR-0001-minimalist-site-code.html +491 -0
- package/dist/docs/decisions/ADR-0002-ai-accessibility.html +434 -0
- package/dist/docs/decisions/ADR-0003-single-file-bundle.html +412 -0
- package/dist/docs/decisions/ADR-0004-bun-runtime.html +409 -0
- package/dist/docs/decisions/ADR-0005-plugin-contract-and-distribution.html +402 -0
- package/dist/docs/decisions/DDR-0001-viewport-locked-layout.html +459 -0
- package/dist/docs/decisions/DDR-0002-theme-system.html +452 -0
- package/dist/docs/decisions/DDR-0003-bounded-logo-slot.html +423 -0
- package/dist/docs/decisions/DDR-0004-slides-rendering-model.html +399 -0
- package/dist/docs/decisions/DDR-0005-deterministic-layout-boundary.html +422 -0
- package/dist/docs/decisions/index.html +11 -0
- package/dist/docs/userguide/cli/build.html +408 -0
- package/dist/docs/userguide/cli/bundle.html +419 -0
- package/dist/docs/userguide/cli/dev.html +428 -0
- package/dist/docs/userguide/cli/index.html +11 -0
- package/dist/docs/userguide/cli/init.html +436 -0
- package/dist/docs/userguide/cli/servers.html +393 -0
- package/dist/docs/userguide/cli/stop.html +408 -0
- package/dist/docs/userguide/cli/update.html +406 -0
- package/dist/docs/userguide/cli/version.html +406 -0
- package/dist/docs/userguide/cli.html +386 -0
- package/dist/docs/userguide/index.html +11 -0
- package/dist/docs/userguide/sharing.html +465 -0
- package/dist/index.html +387 -0
- package/dist/llms.txt +18 -0
- package/dist/provenance.json +7 -0
- package/dist/schemas/index.html +11 -0
- package/dist/schemas/plugin-registry.schema.html +327 -0
- package/dist/schemas/plugin-schemas-notes.html +364 -0
- package/dist/schemas/plugin.schema.html +327 -0
- package/dist/schemas/plugins.schema.html +327 -0
- package/dist/schemas/v0/common.schema.html +386 -0
- package/dist/schemas/v0/index.html +11 -0
- package/dist/schemas/v0/plugin-registry.schema.html +547 -0
- package/dist/schemas/v0/plugin.schema.html +497 -0
- package/dist/schemas/v0/plugins.schema.html +406 -0
- package/dist/schemas/v0/site.schema.html +541 -0
- package/dist/schemas/v0/theme.schema.html +615 -0
- package/dist/schemas.html +351 -0
- package/dist/styles.css +1262 -0
- package/package.json +4 -2
- package/plugins-dist/callouts.css +32 -0
- package/plugins-dist/callouts.js +46 -0
- package/plugins-dist/slides-visuals.css +390 -0
- package/plugins-dist/slides-visuals.js +689 -0
- package/registry/plugins.yaml +35 -0
- package/schemas/README.md +10 -0
- package/schemas/plugin-registry.schema.json +5 -0
- package/schemas/plugin-schemas-notes.md +71 -0
- package/schemas/plugin.schema.json +5 -0
- package/schemas/plugins.schema.json +5 -0
- package/schemas/v0/common.schema.json +64 -0
- package/schemas/v0/plugin-registry.schema.json +225 -0
- package/schemas/v0/plugin.schema.json +175 -0
- package/schemas/v0/plugins.schema.json +84 -0
- package/schemas/v0/site.schema.json +56 -9
- package/schemas/v0/theme.schema.json +105 -22
- package/scripts/build.ts +158 -3
- package/scripts/bundle.ts +261 -95
- package/scripts/dev.ts +301 -11
- package/src/__tests__/build.test.ts +220 -1
- package/src/__tests__/bundle.test.ts +31 -0
- package/src/__tests__/cli.test.ts +14 -3
- package/src/__tests__/dev-plugin-errors.test.ts +20 -0
- package/src/__tests__/fixtures/fences/slides-visuals/invalid/bad-list-indent.md +5 -0
- package/src/__tests__/fixtures/fences/slides-visuals/invalid/blank-line.md +5 -0
- package/src/__tests__/fixtures/fences/slides-visuals/invalid/compare-object-items.md +9 -0
- package/src/__tests__/fixtures/fences/slides-visuals/invalid/flow-branching-no-source.md +5 -0
- package/src/__tests__/fixtures/fences/slides-visuals/invalid/flow-converging-no-target.md +6 -0
- package/src/__tests__/fixtures/fences/slides-visuals/invalid/indented-fence.md +4 -0
- package/src/__tests__/fixtures/fences/slides-visuals/invalid/staircase-empty-steps.md +3 -0
- package/src/__tests__/fixtures/fences/slides-visuals/invalid/stat-grid-missing-fields.md +5 -0
- package/src/__tests__/fixtures/fences/slides-visuals/invalid/timeline-horizontal-no-events.md +2 -0
- package/src/__tests__/fixtures/fences/slides-visuals/invalid/unknown-type.md +3 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/compare.md +10 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/comparison-table.md +14 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/flow-branching-no-split.md +7 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/flow-branching.md +8 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/flow-converging-no-merge.md +7 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/flow-converging.md +8 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/funnel.md +7 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/kpi.md +5 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/layer-cake.md +6 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/pyramid.md +6 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/quadrant-grid.md +8 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/scorecard.md +13 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/staircase-down.md +7 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/staircase.md +8 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/stat-grid.md +8 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/timeline-horizontal.md +9 -0
- package/src/__tests__/fixtures/fences/slides-visuals/valid/timeline-vertical.md +10 -0
- package/src/__tests__/init.test.ts +35 -0
- package/src/__tests__/plugin-loader.test.ts +221 -0
- package/src/__tests__/shared.test.ts +451 -0
- package/src/__tests__/slides-visuals-fence-contract.test.ts +28 -0
- package/src/__tests__/slides-visuals-runtime-regressions.bun.test.ts +147 -0
- package/src/__tests__/styles.test.ts +35 -0
- package/src/cli.ts +9 -4
- package/src/plugin-loader.ts +245 -0
- package/src/shared.ts +650 -7
- package/src/site/styles.css +331 -0
- package/src/site/template.html +66 -5
- package/src/templates/deck.ts +186 -0
- package/src/templates/driver.ts +11 -1
- package/src/templates/minimal.ts +1 -0
|
@@ -0,0 +1,382 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>Recipe: Vercel - Kitfly Docs</title>
|
|
7
|
+
<link rel="icon" type="image/png" sizes="32x32" href="../../../assets/brand/kitfly-favicon-32.png">
|
|
8
|
+
<link rel="icon" type="image/png" sizes="64x64" href="../../../assets/brand/kitfly-neon-256.png">
|
|
9
|
+
<link rel="stylesheet" href="../../../styles.css">
|
|
10
|
+
<style id="kitfly-theme">
|
|
11
|
+
:root { --color-bg: #ffffff;
|
|
12
|
+
--color-bg-sidebar: #f5f7f8;
|
|
13
|
+
--color-text: #374151;
|
|
14
|
+
--color-text-muted: #6b7280;
|
|
15
|
+
--color-border: #e5e7eb;
|
|
16
|
+
--color-link: #007182;
|
|
17
|
+
--color-link-hover: #0a6172;
|
|
18
|
+
--color-accent: #152F46;
|
|
19
|
+
--color-code-bg: #f5f7f8;
|
|
20
|
+
--color-logo: #152F46;
|
|
21
|
+
--sidebar-width: 280px;
|
|
22
|
+
--font-sans: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
|
|
23
|
+
--font-headings: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
|
|
24
|
+
--font-mono: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, monospace; }
|
|
25
|
+
html { font-size: 16px; }
|
|
26
|
+
@media (prefers-color-scheme: dark) {
|
|
27
|
+
:root:not([data-theme="light"]) { --color-bg: #0d1117;
|
|
28
|
+
--color-bg-sidebar: #152F46;
|
|
29
|
+
--color-text: #e5e7eb;
|
|
30
|
+
--color-text-muted: #9ca3af;
|
|
31
|
+
--color-border: #374151;
|
|
32
|
+
--color-link: #709EA6;
|
|
33
|
+
--color-link-hover: #8fb5bc;
|
|
34
|
+
--color-accent: #f9fafb;
|
|
35
|
+
--color-code-bg: #152F46;
|
|
36
|
+
--color-logo: #f9fafb; }
|
|
37
|
+
}
|
|
38
|
+
[data-theme="dark"] { --color-bg: #0d1117;
|
|
39
|
+
--color-bg-sidebar: #152F46;
|
|
40
|
+
--color-text: #e5e7eb;
|
|
41
|
+
--color-text-muted: #9ca3af;
|
|
42
|
+
--color-border: #374151;
|
|
43
|
+
--color-link: #709EA6;
|
|
44
|
+
--color-link-hover: #8fb5bc;
|
|
45
|
+
--color-accent: #f9fafb;
|
|
46
|
+
--color-code-bg: #152F46;
|
|
47
|
+
--color-logo: #f9fafb; }
|
|
48
|
+
[data-theme="light"] { --color-bg: #ffffff;
|
|
49
|
+
--color-bg-sidebar: #f5f7f8;
|
|
50
|
+
--color-text: #374151;
|
|
51
|
+
--color-text-muted: #6b7280;
|
|
52
|
+
--color-border: #e5e7eb;
|
|
53
|
+
--color-link: #007182;
|
|
54
|
+
--color-link-hover: #0a6172;
|
|
55
|
+
--color-accent: #152F46;
|
|
56
|
+
--color-code-bg: #f5f7f8;
|
|
57
|
+
--color-logo: #152F46;
|
|
58
|
+
--sidebar-width: 280px;
|
|
59
|
+
--font-sans: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
|
|
60
|
+
--font-headings: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
|
|
61
|
+
--font-mono: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, monospace; }
|
|
62
|
+
</style>
|
|
63
|
+
<!-- Syntax highlighting - Prism.js -->
|
|
64
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1/themes/prism.min.css" id="prism-light">
|
|
65
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1/themes/prism-okaidia.min.css" id="prism-dark" disabled>
|
|
66
|
+
|
|
67
|
+
<script>
|
|
68
|
+
// Apply saved theme immediately to prevent flash
|
|
69
|
+
(function() {
|
|
70
|
+
const saved = localStorage.getItem('theme');
|
|
71
|
+
if (saved) {
|
|
72
|
+
document.documentElement.setAttribute('data-theme', saved);
|
|
73
|
+
}
|
|
74
|
+
// Set Prism theme based on saved or system preference
|
|
75
|
+
const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
|
|
76
|
+
const isDark = saved === 'dark' || (!saved && prefersDark);
|
|
77
|
+
if (isDark) {
|
|
78
|
+
document.getElementById('prism-light')?.setAttribute('disabled', '');
|
|
79
|
+
document.getElementById('prism-dark')?.removeAttribute('disabled');
|
|
80
|
+
}
|
|
81
|
+
})();
|
|
82
|
+
</script>
|
|
83
|
+
</head>
|
|
84
|
+
<body class="mode-docs">
|
|
85
|
+
<div class="mobile-header">
|
|
86
|
+
<button class="nav-toggle" onclick="toggleNav()" aria-label="Toggle navigation">
|
|
87
|
+
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
|
88
|
+
<path d="M3 12h18M3 6h18M3 18h18"/>
|
|
89
|
+
</svg>
|
|
90
|
+
</button>
|
|
91
|
+
<a href="../../../" class="mobile-logo" title="Home" data-initial="K">
|
|
92
|
+
<img src="../../../assets/brand/kitfly-neon-256.png" alt="Kitfly" class="logo-img logo-icon" onerror="this.onerror=null;this.style.display='none';this.parentElement.classList.add('logo-fallback')"/>
|
|
93
|
+
</a>
|
|
94
|
+
<button class="mobile-theme-toggle" onclick="toggleTheme()" title="Toggle theme" aria-label="Toggle theme">
|
|
95
|
+
<svg class="icon-sun" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
|
96
|
+
<circle cx="12" cy="12" r="5"/>
|
|
97
|
+
<path d="M12 1v2M12 21v2M4.22 4.22l1.42 1.42M18.36 18.36l1.42 1.42M1 12h2M21 12h2M4.22 19.78l1.42-1.42M18.36 5.64l1.42-1.42"/>
|
|
98
|
+
</svg>
|
|
99
|
+
<svg class="icon-moon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
|
100
|
+
<path d="M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79z"/>
|
|
101
|
+
</svg>
|
|
102
|
+
</button>
|
|
103
|
+
</div>
|
|
104
|
+
<div class="layout">
|
|
105
|
+
<nav class="sidebar">
|
|
106
|
+
<div class="sidebar-header">
|
|
107
|
+
<div class="logo logo-icon">
|
|
108
|
+
<a href="/" class="logo-icon" data-initial="K">
|
|
109
|
+
<img src="../../../assets/brand/kitfly-neon-256.png" alt="Kitfly" class="logo-img" onerror="this.onerror=null;this.style.display='none';this.parentElement.classList.add('logo-fallback')"/>
|
|
110
|
+
</a>
|
|
111
|
+
<span class="logo-text">
|
|
112
|
+
<a href="/" class="brand">Kitfly</a>
|
|
113
|
+
<a href="../../../" class="product">Kitfly Docs</a>
|
|
114
|
+
</span>
|
|
115
|
+
</div>
|
|
116
|
+
<div class="header-tools">
|
|
117
|
+
<button class="theme-toggle" onclick="toggleTheme()" title="Toggle theme" aria-label="Toggle theme">
|
|
118
|
+
<svg class="icon-sun" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
|
119
|
+
<circle cx="12" cy="12" r="5"/>
|
|
120
|
+
<path d="M12 1v2M12 21v2M4.22 4.22l1.42 1.42M18.36 18.36l1.42 1.42M1 12h2M21 12h2M4.22 19.78l1.42-1.42M18.36 5.64l1.42-1.42"/>
|
|
121
|
+
</svg>
|
|
122
|
+
<svg class="icon-moon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
|
123
|
+
<path d="M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79z"/>
|
|
124
|
+
</svg>
|
|
125
|
+
</button>
|
|
126
|
+
<div class="sidebar-meta">
|
|
127
|
+
<span class="meta-version">v0.2.1</span>
|
|
128
|
+
<span class="meta-branch">HEAD</span>
|
|
129
|
+
</div>
|
|
130
|
+
</div>
|
|
131
|
+
</div>
|
|
132
|
+
<div class="sidebar-nav">
|
|
133
|
+
<ul><li><a href="../../../index.html" class="nav-home">Home</a></li><li><span class="nav-section">Guide</span><ul><li><a href="../../../content/guide/approaches.html">approaches</a></li><li><a href="../../../content/guide/features.html">features</a></li><li><a href="../../../content/guide/getting-started.html">getting-started</a></li><li><a href="../../../content/guide/kitfly-overview.html">kitfly-overview</a></li></ul></li><li><span class="nav-section">Templates</span><ul><li><a href="../../../content/templates/crucible.html">crucible</a></li><li><a href="../../../content/templates/handbook.html">handbook</a></li><li><a href="../../../content/templates/minimal.html">minimal</a></li><li><a href="../../../content/templates/overview.html">overview</a></li><li><a href="../../../content/templates/pipeline.html">pipeline</a></li><li><a href="../../../content/templates/productbook.html">productbook</a></li><li><a href="../../../content/templates/runbook.html">runbook</a></li><li><a href="../../../content/templates/servicebook.html">servicebook</a></li></ul></li><li><a href="../../../content/reference.html" class="nav-section">Reference</a><ul><li><a href="../../../content/reference/configuration.html">configuration</a></li><li><a href="../../../content/reference/design-catalog.html">design-catalog</a></li><li><a href="../../../content/reference/environment-variables.html">environment-variables</a></li><li><a href="../../../content/reference/glossary.html">glossary</a></li><li><a href="../../../content/reference/key-concepts.html">key-concepts</a></li><li><a href="../../../content/reference/plugins.html">plugins</a></li><li><a href="../../../content/reference/slides-authoring-guidelines.html">slides-authoring-guidelines</a></li><li><a href="../../../content/reference/structure.html">structure</a></li></ul></li><li><a href="../../../content/deployment.html" class="nav-section">Deployment</a><ul><li><a href="../../../content/deployment/preflight.html">preflight</a></li><li><details open><summary class="nav-group">recipes</summary><ul><li><a href="../../../content/deployment/recipes/aws-s3.html">aws-s3</a></li><li><a href="../../../content/deployment/recipes/cloudflare-pages.html">cloudflare-pages</a></li><li><a href="../../../content/deployment/recipes/cloudflare-r2.html">cloudflare-r2</a></li><li><a href="../../../content/deployment/recipes/fly-io.html">fly-io</a></li><li><a href="../../../content/deployment/recipes/github-pages.html">github-pages</a></li><li><a href="../../../content/deployment/recipes/netlify.html">netlify</a></li><li><a href="../../../content/deployment/recipes/vercel.html" class="active">vercel</a></li></ul></details></li><li><a href="../../../content/deployment/secrets-and-env-vars.html">secrets-and-env-vars</a></li></ul></li><li><span class="nav-section">User Guide</span><ul><li><details><summary class="nav-group"><a href="../../../docs/userguide/cli.html">cli</a></summary><ul><li><a href="../../../docs/userguide/cli/build.html">build</a></li><li><a href="../../../docs/userguide/cli/bundle.html">bundle</a></li><li><a href="../../../docs/userguide/cli/dev.html">dev</a></li><li><a href="../../../docs/userguide/cli/init.html">init</a></li><li><a href="../../../docs/userguide/cli/servers.html">servers</a></li><li><a href="../../../docs/userguide/cli/stop.html">stop</a></li><li><a href="../../../docs/userguide/cli/update.html">update</a></li><li><a href="../../../docs/userguide/cli/version.html">version</a></li></ul></details></li><li><a href="../../../docs/userguide/sharing.html">sharing</a></li></ul></li><li><span class="nav-section">Decisions</span><ul><li><a href="../../../docs/decisions/ADR-0001-minimalist-site-code.html">ADR-0001-minimalist-site-code</a></li><li><a href="../../../docs/decisions/ADR-0002-ai-accessibility.html">ADR-0002-ai-accessibility</a></li><li><a href="../../../docs/decisions/ADR-0003-single-file-bundle.html">ADR-0003-single-file-bundle</a></li><li><a href="../../../docs/decisions/ADR-0004-bun-runtime.html">ADR-0004-bun-runtime</a></li><li><a href="../../../docs/decisions/ADR-0005-plugin-contract-and-distribution.html">ADR-0005-plugin-contract-and-distribution</a></li><li><a href="../../../docs/decisions/DDR-0001-viewport-locked-layout.html">DDR-0001-viewport-locked-layout</a></li><li><a href="../../../docs/decisions/DDR-0002-theme-system.html">DDR-0002-theme-system</a></li><li><a href="../../../docs/decisions/DDR-0003-bounded-logo-slot.html">DDR-0003-bounded-logo-slot</a></li><li><a href="../../../docs/decisions/DDR-0004-slides-rendering-model.html">DDR-0004-slides-rendering-model</a></li><li><a href="../../../docs/decisions/DDR-0005-deterministic-layout-boundary.html">DDR-0005-deterministic-layout-boundary</a></li></ul></li><li><a href="../../../schemas.html" class="nav-section">Schemas</a><ul><li><a href="../../../schemas/plugin-registry.schema.html">plugin-registry.schema</a></li><li><a href="../../../schemas/plugin-schemas-notes.html">plugin-schemas-notes</a></li><li><a href="../../../schemas/plugin.schema.html">plugin.schema</a></li><li><a href="../../../schemas/plugins.schema.html">plugins.schema</a></li><li><details><summary class="nav-group">v0</summary><ul><li><a href="../../../schemas/v0/common.schema.html">common.schema</a></li><li><a href="../../../schemas/v0/plugin-registry.schema.html">plugin-registry.schema</a></li><li><a href="../../../schemas/v0/plugin.schema.html">plugin.schema</a></li><li><a href="../../../schemas/v0/plugins.schema.html">plugins.schema</a></li><li><a href="../../../schemas/v0/site.schema.html">site.schema</a></li><li><a href="../../../schemas/v0/theme.schema.html">theme.schema</a></li></ul></details></li></ul></li></ul>
|
|
134
|
+
</div>
|
|
135
|
+
</nav>
|
|
136
|
+
<main class="content">
|
|
137
|
+
<article class="prose">
|
|
138
|
+
<nav class="breadcrumbs"><a href="../../../content/guide/approaches.html">Content</a><span class="separator">›</span><a href="../../../content/deployment/preflight.html">Deployment</a><span class="separator">›</span><a href="../../../content/deployment/recipes/aws-s3.html">Recipes</a><span class="separator">›</span><span>vercel</span></nav>
|
|
139
|
+
<div class="page-meta">Last updated: 2026-02-12</div>
|
|
140
|
+
<h1 id="recipe-vercel">Recipe: Vercel</h1>
|
|
141
|
+
<p>Vercel is a good choice when you want fast global CDN, a clean dashboard, and simple "push to deploy" with zero config.</p>
|
|
142
|
+
<p>If you're already using Vercel for other projects, this is an easy add.</p>
|
|
143
|
+
<h2 id="prerequisites">Prerequisites</h2>
|
|
144
|
+
<ul>
|
|
145
|
+
<li>A Vercel account</li>
|
|
146
|
+
<li>(For CLI deploys) <code>vercel</code> CLI installed: <code>npm i -g vercel</code></li>
|
|
147
|
+
</ul>
|
|
148
|
+
<h2 id="build">Build</h2>
|
|
149
|
+
<pre><code class="language-bash">make build
|
|
150
|
+
</code></pre>
|
|
151
|
+
<p>Your deployable output is the <code>dist/</code> folder.</p>
|
|
152
|
+
<h2 id="deploy-simplest-drag-and-drop-or-cli">Deploy (simplest: drag-and-drop or CLI)</h2>
|
|
153
|
+
<h3 id="option-a-cli-deploy-quick">Option A: CLI deploy (quick)</h3>
|
|
154
|
+
<p>From your project root:</p>
|
|
155
|
+
<pre><code class="language-bash">vercel deploy dist/
|
|
156
|
+
</code></pre>
|
|
157
|
+
<p>This uploads <code>dist/</code> and gives you a preview URL. To deploy to production:</p>
|
|
158
|
+
<pre><code class="language-bash">vercel deploy dist/ --prod
|
|
159
|
+
</code></pre>
|
|
160
|
+
<h3 id="option-b-connect-a-git-repo-repeatable">Option B: Connect a Git repo (repeatable)</h3>
|
|
161
|
+
<ol>
|
|
162
|
+
<li>Import your repo in Vercel's dashboard</li>
|
|
163
|
+
<li>Set the following in project settings:<ul>
|
|
164
|
+
<li><strong>Build Command</strong>: <code>make build</code></li>
|
|
165
|
+
<li><strong>Output Directory</strong>: <code>dist</code></li>
|
|
166
|
+
<li><strong>Install Command</strong>: <code>bun install</code></li>
|
|
167
|
+
</ul>
|
|
168
|
+
</li>
|
|
169
|
+
</ol>
|
|
170
|
+
<p>Now every push to <code>main</code> triggers a production deploy. Pull requests get preview deploys automatically.</p>
|
|
171
|
+
<h2 id="configuration-file-optional">Configuration file (optional)</h2>
|
|
172
|
+
<p>If you prefer config-as-code, add <code>vercel.json</code> to your project root:</p>
|
|
173
|
+
<pre><code class="language-json">{
|
|
174
|
+
"buildCommand": "make build",
|
|
175
|
+
"outputDirectory": "dist",
|
|
176
|
+
"installCommand": "bun install",
|
|
177
|
+
"framework": null
|
|
178
|
+
}
|
|
179
|
+
</code></pre>
|
|
180
|
+
<p>Setting <code>"framework": null</code> tells Vercel not to auto-detect a framework — Kitfly is not a framework Vercel recognizes, so this avoids unexpected behavior.</p>
|
|
181
|
+
<h2 id="custom-domain-dns-basics">Custom domain (DNS basics)</h2>
|
|
182
|
+
<p>Typical pattern:</p>
|
|
183
|
+
<ul>
|
|
184
|
+
<li><code>docs.example.com</code> → <strong>CNAME</strong> to <code>cname.vercel-dns.com</code></li>
|
|
185
|
+
</ul>
|
|
186
|
+
<p>Vercel's dashboard walks you through adding custom domains. HTTPS is provisioned automatically.</p>
|
|
187
|
+
<h2 id="caching-why-you-might-not-see-changes">Caching (why you might not see changes)</h2>
|
|
188
|
+
<p>If you deploy and your browser still shows old content:</p>
|
|
189
|
+
<ul>
|
|
190
|
+
<li>hard refresh (Shift+Reload)</li>
|
|
191
|
+
<li>try an incognito window</li>
|
|
192
|
+
<li>Vercel CDN cache usually invalidates on deploy, but DNS propagation can take a few minutes</li>
|
|
193
|
+
</ul>
|
|
194
|
+
<h2 id="verify-rollback">Verify + Rollback</h2>
|
|
195
|
+
<ul>
|
|
196
|
+
<li>Verify: load the site, click a few pages, hard refresh</li>
|
|
197
|
+
<li>Rollback: promote a previous deployment from Vercel's dashboard (Deployments → three-dot menu → Promote to Production)</li>
|
|
198
|
+
</ul>
|
|
199
|
+
<p>See: <a href="../preflight.html">Preflight and Rollback</a></p>
|
|
200
|
+
|
|
201
|
+
</article>
|
|
202
|
+
<aside class="toc"><span class="toc-title">On this page</span><ul><li><a href="#prerequisites">Prerequisites</a></li><li><a href="#build">Build</a></li><li><a href="#deploy-simplest-drag-and-drop-or-cli">Deploy (simplest: drag-and-drop or CLI)</a></li><li class="toc-h3"><a href="#option-a-cli-deploy-quick">Option A: CLI deploy (quick)</a></li><li class="toc-h3"><a href="#option-b-connect-a-git-repo-repeatable">Option B: Connect a Git repo (repeatable)</a></li><li><a href="#configuration-file-optional">Configuration file (optional)</a></li><li><a href="#custom-domain-dns-basics">Custom domain (DNS basics)</a></li><li><a href="#caching-why-you-might-not-see-changes">Caching (why you might not see changes)</a></li><li><a href="#verify-rollback">Verify + Rollback</a></li></ul></aside>
|
|
203
|
+
</main>
|
|
204
|
+
</div>
|
|
205
|
+
|
|
206
|
+
<footer class="site-footer">
|
|
207
|
+
<div class="footer-content">
|
|
208
|
+
<div class="footer-left">
|
|
209
|
+
<span class="footer-version">v0.2.1</span>
|
|
210
|
+
<span class="footer-separator">·</span>
|
|
211
|
+
<span class="footer-commit" title="Commit: 30dfc01">Published 2026-02-15</span>
|
|
212
|
+
</div>
|
|
213
|
+
<div class="footer-center">
|
|
214
|
+
<span class="footer-copyright"><a href="https://3leaps.net" class="footer-link">© 2026 3 Leaps, LLC</a></span>
|
|
215
|
+
<span class="footer-separator">·</span><a href="/" class="footer-link">Kitfly</a>
|
|
216
|
+
</div>
|
|
217
|
+
<div class="footer-right">
|
|
218
|
+
<a href="https://kitfly.dev" class="footer-link">Built with Kitfly</a>
|
|
219
|
+
</div>
|
|
220
|
+
</div>
|
|
221
|
+
</footer>
|
|
222
|
+
<!-- Syntax highlighting - Prism.js -->
|
|
223
|
+
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-core.min.js"></script>
|
|
224
|
+
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/plugins/autoloader/prism-autoloader.min.js"></script>
|
|
225
|
+
<!-- Mermaid diagram support -->
|
|
226
|
+
<script type="module">
|
|
227
|
+
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
|
|
228
|
+
|
|
229
|
+
function getMermaidTheme() {
|
|
230
|
+
const theme = document.documentElement.getAttribute('data-theme');
|
|
231
|
+
const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
|
|
232
|
+
const isDark = theme === 'dark' || (!theme && prefersDark);
|
|
233
|
+
return isDark ? 'dark' : 'neutral';
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
mermaid.initialize({
|
|
237
|
+
startOnLoad: true,
|
|
238
|
+
theme: getMermaidTheme()
|
|
239
|
+
});
|
|
240
|
+
|
|
241
|
+
// Re-render mermaid diagrams when theme changes
|
|
242
|
+
window.reinitMermaid = async function() {
|
|
243
|
+
mermaid.initialize({ startOnLoad: false, theme: getMermaidTheme() });
|
|
244
|
+
const diagrams = document.querySelectorAll('.mermaid');
|
|
245
|
+
for (const el of diagrams) {
|
|
246
|
+
const code = el.getAttribute('data-mermaid-source');
|
|
247
|
+
if (code) {
|
|
248
|
+
el.innerHTML = code;
|
|
249
|
+
el.removeAttribute('data-processed');
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
await mermaid.run({ nodes: diagrams });
|
|
253
|
+
};
|
|
254
|
+
</script>
|
|
255
|
+
|
|
256
|
+
<script>
|
|
257
|
+
function toggleTheme() {
|
|
258
|
+
const html = document.documentElement;
|
|
259
|
+
const current = html.getAttribute('data-theme');
|
|
260
|
+
const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
|
|
261
|
+
|
|
262
|
+
let next;
|
|
263
|
+
if (current === 'dark') {
|
|
264
|
+
next = 'light';
|
|
265
|
+
} else if (current === 'light') {
|
|
266
|
+
next = 'dark';
|
|
267
|
+
} else {
|
|
268
|
+
// No explicit theme set, toggle from system preference
|
|
269
|
+
next = prefersDark ? 'light' : 'dark';
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
html.setAttribute('data-theme', next);
|
|
273
|
+
localStorage.setItem('theme', next);
|
|
274
|
+
|
|
275
|
+
// Switch Prism theme
|
|
276
|
+
const prismLight = document.getElementById('prism-light');
|
|
277
|
+
const prismDark = document.getElementById('prism-dark');
|
|
278
|
+
if (next === 'dark') {
|
|
279
|
+
prismLight?.setAttribute('disabled', '');
|
|
280
|
+
prismDark?.removeAttribute('disabled');
|
|
281
|
+
} else {
|
|
282
|
+
prismLight?.removeAttribute('disabled');
|
|
283
|
+
prismDark?.setAttribute('disabled', '');
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
// Re-render mermaid diagrams with new theme
|
|
287
|
+
if (window.reinitMermaid) {
|
|
288
|
+
window.reinitMermaid();
|
|
289
|
+
}
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
// Slides mode hash routing
|
|
293
|
+
(function initSlidesMode() {
|
|
294
|
+
const shell = document.querySelector('.slides-shell');
|
|
295
|
+
if (!shell) return;
|
|
296
|
+
|
|
297
|
+
const slides = Array.from(document.querySelectorAll('.slide'));
|
|
298
|
+
if (!slides.length) return;
|
|
299
|
+
|
|
300
|
+
const prevBtn = document.querySelector('.slide-prev');
|
|
301
|
+
const nextBtn = document.querySelector('.slide-next');
|
|
302
|
+
const counter = document.querySelector('.slide-counter');
|
|
303
|
+
const progressBar = document.querySelector('.slide-progress-bar');
|
|
304
|
+
const navLinks = Array.from(document.querySelectorAll('.sidebar-nav a[href^="#slide-"]'));
|
|
305
|
+
let current = 0;
|
|
306
|
+
|
|
307
|
+
function setActive(n) {
|
|
308
|
+
current = Math.max(0, Math.min(n, slides.length - 1));
|
|
309
|
+
slides.forEach((slide, idx) => slide.classList.toggle('active', idx === current));
|
|
310
|
+
navLinks.forEach((link) => {
|
|
311
|
+
const active = link.getAttribute('href') === '#' + slides[current].id;
|
|
312
|
+
link.classList.toggle('active', active);
|
|
313
|
+
});
|
|
314
|
+
if (counter) counter.textContent = (current + 1) + ' / ' + slides.length;
|
|
315
|
+
if (progressBar) progressBar.style.width = (((current + 1) / slides.length) * 100) + '%';
|
|
316
|
+
if (prevBtn) prevBtn.disabled = current === 0;
|
|
317
|
+
if (nextBtn) nextBtn.disabled = current === slides.length - 1;
|
|
318
|
+
history.replaceState(null, '', '#' + slides[current].id);
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
function setFromHash() {
|
|
322
|
+
const hash = window.location.hash || '';
|
|
323
|
+
const idx = slides.findIndex((s) => '#' + s.id === hash);
|
|
324
|
+
if (idx >= 0) setActive(idx);
|
|
325
|
+
else setActive(0);
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
prevBtn?.addEventListener('click', () => setActive(current - 1));
|
|
329
|
+
nextBtn?.addEventListener('click', () => setActive(current + 1));
|
|
330
|
+
|
|
331
|
+
document.addEventListener('keydown', (e) => {
|
|
332
|
+
if (e.key === 'ArrowRight' || e.key === ' ') {
|
|
333
|
+
e.preventDefault();
|
|
334
|
+
setActive(current + 1);
|
|
335
|
+
} else if (e.key === 'ArrowLeft') {
|
|
336
|
+
e.preventDefault();
|
|
337
|
+
setActive(current - 1);
|
|
338
|
+
} else if (e.key === 'Home') {
|
|
339
|
+
e.preventDefault();
|
|
340
|
+
setActive(0);
|
|
341
|
+
} else if (e.key === 'End') {
|
|
342
|
+
e.preventDefault();
|
|
343
|
+
setActive(slides.length - 1);
|
|
344
|
+
}
|
|
345
|
+
});
|
|
346
|
+
|
|
347
|
+
window.addEventListener('hashchange', setFromHash);
|
|
348
|
+
setFromHash();
|
|
349
|
+
})();
|
|
350
|
+
|
|
351
|
+
// Copy code button
|
|
352
|
+
document.querySelectorAll('.prose pre code').forEach(block => {
|
|
353
|
+
const button = document.createElement('button');
|
|
354
|
+
button.className = 'copy-button';
|
|
355
|
+
button.textContent = 'Copy';
|
|
356
|
+
button.onclick = async () => {
|
|
357
|
+
await navigator.clipboard.writeText(block.textContent);
|
|
358
|
+
button.textContent = 'Copied!';
|
|
359
|
+
setTimeout(() => button.textContent = 'Copy', 2000);
|
|
360
|
+
};
|
|
361
|
+
block.parentElement.appendChild(button);
|
|
362
|
+
});
|
|
363
|
+
|
|
364
|
+
// Mobile nav toggle
|
|
365
|
+
function toggleNav() {
|
|
366
|
+
document.querySelector('.sidebar').classList.toggle('open');
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
// Close nav when clicking outside on mobile
|
|
370
|
+
document.addEventListener('click', (e) => {
|
|
371
|
+
const sidebar = document.querySelector('.sidebar');
|
|
372
|
+
const toggle = document.querySelector('.nav-toggle');
|
|
373
|
+
if (sidebar.classList.contains('open') &&
|
|
374
|
+
!sidebar.contains(e.target) &&
|
|
375
|
+
!toggle.contains(e.target)) {
|
|
376
|
+
sidebar.classList.remove('open');
|
|
377
|
+
}
|
|
378
|
+
});
|
|
379
|
+
</script>
|
|
380
|
+
|
|
381
|
+
</body>
|
|
382
|
+
</html>
|