kitfly 0.1.2 → 0.2.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/CHANGELOG.md +34 -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/structure.md +166 -0
- package/dist/_raw/content/reference.md +19 -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/structure.html +463 -0
- package/dist/content/reference.html +334 -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 +540 -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 +224 -0
- package/plugins-dist/slides-visuals.js +598 -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 +155 -3
- package/scripts/bundle.ts +258 -95
- package/scripts/dev.ts +203 -1
- package/src/__tests__/build.test.ts +158 -1
- package/src/__tests__/bundle.test.ts +31 -0
- package/src/__tests__/cli.test.ts +14 -3
- 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/indented-fence.md +4 -0
- package/src/__tests__/fixtures/fences/slides-visuals/invalid/stat-grid-missing-fields.md +5 -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/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/stat-grid.md +8 -0
- package/src/__tests__/init.test.ts +35 -0
- package/src/__tests__/plugin-loader.test.ts +221 -0
- package/src/__tests__/shared.test.ts +428 -0
- package/src/__tests__/slides-visuals-fence-contract.test.ts +28 -0
- package/src/__tests__/slides-visuals-runtime-regressions.bun.test.ts +114 -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 +614 -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,380 @@
|
|
|
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>Secrets and Environment Variables - 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.0</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/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><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">vercel</a></li></ul></details></li><li><a href="../../content/deployment/secrets-and-env-vars.html" class="active">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><span>secrets-and-env-vars</span></nav>
|
|
139
|
+
<div class="page-meta">Last updated: 2026-02-12</div>
|
|
140
|
+
<h1 id="secrets-and-environment-variables">Secrets and Environment Variables</h1>
|
|
141
|
+
<p>Most Kitfly deployments need <strong>no secrets</strong> because the output is static.</p>
|
|
142
|
+
<p>You only need secrets when a <em>deployment tool</em> needs credentials (AWS CLI, Netlify CLI, etc.).</p>
|
|
143
|
+
<h2 id="the-one-rule">The one rule</h2>
|
|
144
|
+
<p>Never commit secrets to git.</p>
|
|
145
|
+
<p>That includes:</p>
|
|
146
|
+
<ul>
|
|
147
|
+
<li><code>.env</code> files</li>
|
|
148
|
+
<li>API tokens</li>
|
|
149
|
+
<li>access keys</li>
|
|
150
|
+
<li>private keys</li>
|
|
151
|
+
</ul>
|
|
152
|
+
<p>If you already committed something sensitive, treat it as leaked:</p>
|
|
153
|
+
<ul>
|
|
154
|
+
<li>rotate/revoke it</li>
|
|
155
|
+
<li>remove it from git history if needed</li>
|
|
156
|
+
</ul>
|
|
157
|
+
<h2 id="beginner-friendly-pattern">Beginner-friendly pattern</h2>
|
|
158
|
+
<ol>
|
|
159
|
+
<li>Put secret values in environment variables (or your host's secret store).</li>
|
|
160
|
+
<li>Keep a local <code>.env</code> file <em>only if you must</em> — and make sure it is gitignored.</li>
|
|
161
|
+
<li>Use placeholder examples (<code>.env.example</code>) to document required variables.</li>
|
|
162
|
+
</ol>
|
|
163
|
+
<h2 id="what-is-an-environment-variable">What is an environment variable?</h2>
|
|
164
|
+
<p>An environment variable is a named value your terminal (or hosting platform) provides to a command.</p>
|
|
165
|
+
<p>If you want a quick primer with copy-paste commands, see:</p>
|
|
166
|
+
<ul>
|
|
167
|
+
<li><a href="../reference/environment-variables.html">Reference: Environment Variables</a></li>
|
|
168
|
+
</ul>
|
|
169
|
+
<h2 id="host-secret-stores-recommended">Host secret stores (recommended)</h2>
|
|
170
|
+
<p>If your host offers a "Secrets" UI, use it. It's harder to accidentally leak.</p>
|
|
171
|
+
<p>Examples (names vary by provider):</p>
|
|
172
|
+
<ul>
|
|
173
|
+
<li>"Environment variables"</li>
|
|
174
|
+
<li>"Secrets"</li>
|
|
175
|
+
<li>"Build & deploy settings"</li>
|
|
176
|
+
</ul>
|
|
177
|
+
<h2 id="least-privilege-plain-language">Least privilege (plain language)</h2>
|
|
178
|
+
<p>Create credentials that can do only what deployment needs.</p>
|
|
179
|
+
<p>Examples:</p>
|
|
180
|
+
<ul>
|
|
181
|
+
<li>An AWS IAM user/policy that can only write to one S3 bucket</li>
|
|
182
|
+
<li>A Netlify token that can only deploy to one site (if supported)</li>
|
|
183
|
+
<li>A Cloudflare API token scoped to a single zone or R2 bucket</li>
|
|
184
|
+
</ul>
|
|
185
|
+
<h2 id="do-dont">Do / Don't</h2>
|
|
186
|
+
<p><strong>Do</strong></p>
|
|
187
|
+
<ul>
|
|
188
|
+
<li>Do keep secrets in a password manager</li>
|
|
189
|
+
<li>Do rotate tokens periodically</li>
|
|
190
|
+
<li>Do prefer scoped tokens over "account owner" tokens</li>
|
|
191
|
+
</ul>
|
|
192
|
+
<p><strong>Don't</strong></p>
|
|
193
|
+
<ul>
|
|
194
|
+
<li>Don't paste secrets into docs</li>
|
|
195
|
+
<li>Don't put secrets in <code>site.yaml</code></li>
|
|
196
|
+
<li>Don't share secrets in Slack threads</li>
|
|
197
|
+
</ul>
|
|
198
|
+
|
|
199
|
+
</article>
|
|
200
|
+
<aside class="toc"><span class="toc-title">On this page</span><ul><li><a href="#the-one-rule">The one rule</a></li><li><a href="#beginner-friendly-pattern">Beginner-friendly pattern</a></li><li><a href="#what-is-an-environment-variable">What is an environment variable?</a></li><li><a href="#host-secret-stores-recommended">Host secret stores (recommended)</a></li><li><a href="#least-privilege-plain-language">Least privilege (plain language)</a></li><li><a href="#do-dont">Do / Don't</a></li></ul></aside>
|
|
201
|
+
</main>
|
|
202
|
+
</div>
|
|
203
|
+
|
|
204
|
+
<footer class="site-footer">
|
|
205
|
+
<div class="footer-content">
|
|
206
|
+
<div class="footer-left">
|
|
207
|
+
<span class="footer-version">v0.2.0</span>
|
|
208
|
+
<span class="footer-separator">·</span>
|
|
209
|
+
<span class="footer-commit" title="Commit: 33ccd68">Published 2026-02-15</span>
|
|
210
|
+
</div>
|
|
211
|
+
<div class="footer-center">
|
|
212
|
+
<span class="footer-copyright"><a href="https://3leaps.net" class="footer-link">© 2026 3 Leaps, LLC</a></span>
|
|
213
|
+
<span class="footer-separator">·</span><a href="/" class="footer-link">Kitfly</a>
|
|
214
|
+
</div>
|
|
215
|
+
<div class="footer-right">
|
|
216
|
+
<a href="https://kitfly.dev" class="footer-link">Built with Kitfly</a>
|
|
217
|
+
</div>
|
|
218
|
+
</div>
|
|
219
|
+
</footer>
|
|
220
|
+
<!-- Syntax highlighting - Prism.js -->
|
|
221
|
+
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-core.min.js"></script>
|
|
222
|
+
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/plugins/autoloader/prism-autoloader.min.js"></script>
|
|
223
|
+
<!-- Mermaid diagram support -->
|
|
224
|
+
<script type="module">
|
|
225
|
+
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
|
|
226
|
+
|
|
227
|
+
function getMermaidTheme() {
|
|
228
|
+
const theme = document.documentElement.getAttribute('data-theme');
|
|
229
|
+
const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
|
|
230
|
+
const isDark = theme === 'dark' || (!theme && prefersDark);
|
|
231
|
+
return isDark ? 'dark' : 'neutral';
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
mermaid.initialize({
|
|
235
|
+
startOnLoad: true,
|
|
236
|
+
theme: getMermaidTheme()
|
|
237
|
+
});
|
|
238
|
+
|
|
239
|
+
// Re-render mermaid diagrams when theme changes
|
|
240
|
+
window.reinitMermaid = async function() {
|
|
241
|
+
mermaid.initialize({ startOnLoad: false, theme: getMermaidTheme() });
|
|
242
|
+
const diagrams = document.querySelectorAll('.mermaid');
|
|
243
|
+
for (const el of diagrams) {
|
|
244
|
+
const code = el.getAttribute('data-mermaid-source');
|
|
245
|
+
if (code) {
|
|
246
|
+
el.innerHTML = code;
|
|
247
|
+
el.removeAttribute('data-processed');
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
await mermaid.run({ nodes: diagrams });
|
|
251
|
+
};
|
|
252
|
+
</script>
|
|
253
|
+
|
|
254
|
+
<script>
|
|
255
|
+
function toggleTheme() {
|
|
256
|
+
const html = document.documentElement;
|
|
257
|
+
const current = html.getAttribute('data-theme');
|
|
258
|
+
const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
|
|
259
|
+
|
|
260
|
+
let next;
|
|
261
|
+
if (current === 'dark') {
|
|
262
|
+
next = 'light';
|
|
263
|
+
} else if (current === 'light') {
|
|
264
|
+
next = 'dark';
|
|
265
|
+
} else {
|
|
266
|
+
// No explicit theme set, toggle from system preference
|
|
267
|
+
next = prefersDark ? 'light' : 'dark';
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
html.setAttribute('data-theme', next);
|
|
271
|
+
localStorage.setItem('theme', next);
|
|
272
|
+
|
|
273
|
+
// Switch Prism theme
|
|
274
|
+
const prismLight = document.getElementById('prism-light');
|
|
275
|
+
const prismDark = document.getElementById('prism-dark');
|
|
276
|
+
if (next === 'dark') {
|
|
277
|
+
prismLight?.setAttribute('disabled', '');
|
|
278
|
+
prismDark?.removeAttribute('disabled');
|
|
279
|
+
} else {
|
|
280
|
+
prismLight?.removeAttribute('disabled');
|
|
281
|
+
prismDark?.setAttribute('disabled', '');
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
// Re-render mermaid diagrams with new theme
|
|
285
|
+
if (window.reinitMermaid) {
|
|
286
|
+
window.reinitMermaid();
|
|
287
|
+
}
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
// Slides mode hash routing
|
|
291
|
+
(function initSlidesMode() {
|
|
292
|
+
const shell = document.querySelector('.slides-shell');
|
|
293
|
+
if (!shell) return;
|
|
294
|
+
|
|
295
|
+
const slides = Array.from(document.querySelectorAll('.slide'));
|
|
296
|
+
if (!slides.length) return;
|
|
297
|
+
|
|
298
|
+
const prevBtn = document.querySelector('.slide-prev');
|
|
299
|
+
const nextBtn = document.querySelector('.slide-next');
|
|
300
|
+
const counter = document.querySelector('.slide-counter');
|
|
301
|
+
const progressBar = document.querySelector('.slide-progress-bar');
|
|
302
|
+
const navLinks = Array.from(document.querySelectorAll('.sidebar-nav a[href^="#slide-"]'));
|
|
303
|
+
let current = 0;
|
|
304
|
+
|
|
305
|
+
function setActive(n) {
|
|
306
|
+
current = Math.max(0, Math.min(n, slides.length - 1));
|
|
307
|
+
slides.forEach((slide, idx) => slide.classList.toggle('active', idx === current));
|
|
308
|
+
navLinks.forEach((link) => {
|
|
309
|
+
const active = link.getAttribute('href') === '#' + slides[current].id;
|
|
310
|
+
link.classList.toggle('active', active);
|
|
311
|
+
});
|
|
312
|
+
if (counter) counter.textContent = (current + 1) + ' / ' + slides.length;
|
|
313
|
+
if (progressBar) progressBar.style.width = (((current + 1) / slides.length) * 100) + '%';
|
|
314
|
+
if (prevBtn) prevBtn.disabled = current === 0;
|
|
315
|
+
if (nextBtn) nextBtn.disabled = current === slides.length - 1;
|
|
316
|
+
history.replaceState(null, '', '#' + slides[current].id);
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
function setFromHash() {
|
|
320
|
+
const hash = window.location.hash || '';
|
|
321
|
+
const idx = slides.findIndex((s) => '#' + s.id === hash);
|
|
322
|
+
if (idx >= 0) setActive(idx);
|
|
323
|
+
else setActive(0);
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
prevBtn?.addEventListener('click', () => setActive(current - 1));
|
|
327
|
+
nextBtn?.addEventListener('click', () => setActive(current + 1));
|
|
328
|
+
|
|
329
|
+
document.addEventListener('keydown', (e) => {
|
|
330
|
+
if (e.key === 'ArrowRight' || e.key === ' ') {
|
|
331
|
+
e.preventDefault();
|
|
332
|
+
setActive(current + 1);
|
|
333
|
+
} else if (e.key === 'ArrowLeft') {
|
|
334
|
+
e.preventDefault();
|
|
335
|
+
setActive(current - 1);
|
|
336
|
+
} else if (e.key === 'Home') {
|
|
337
|
+
e.preventDefault();
|
|
338
|
+
setActive(0);
|
|
339
|
+
} else if (e.key === 'End') {
|
|
340
|
+
e.preventDefault();
|
|
341
|
+
setActive(slides.length - 1);
|
|
342
|
+
}
|
|
343
|
+
});
|
|
344
|
+
|
|
345
|
+
window.addEventListener('hashchange', setFromHash);
|
|
346
|
+
setFromHash();
|
|
347
|
+
})();
|
|
348
|
+
|
|
349
|
+
// Copy code button
|
|
350
|
+
document.querySelectorAll('.prose pre code').forEach(block => {
|
|
351
|
+
const button = document.createElement('button');
|
|
352
|
+
button.className = 'copy-button';
|
|
353
|
+
button.textContent = 'Copy';
|
|
354
|
+
button.onclick = async () => {
|
|
355
|
+
await navigator.clipboard.writeText(block.textContent);
|
|
356
|
+
button.textContent = 'Copied!';
|
|
357
|
+
setTimeout(() => button.textContent = 'Copy', 2000);
|
|
358
|
+
};
|
|
359
|
+
block.parentElement.appendChild(button);
|
|
360
|
+
});
|
|
361
|
+
|
|
362
|
+
// Mobile nav toggle
|
|
363
|
+
function toggleNav() {
|
|
364
|
+
document.querySelector('.sidebar').classList.toggle('open');
|
|
365
|
+
}
|
|
366
|
+
|
|
367
|
+
// Close nav when clicking outside on mobile
|
|
368
|
+
document.addEventListener('click', (e) => {
|
|
369
|
+
const sidebar = document.querySelector('.sidebar');
|
|
370
|
+
const toggle = document.querySelector('.nav-toggle');
|
|
371
|
+
if (sidebar.classList.contains('open') &&
|
|
372
|
+
!sidebar.contains(e.target) &&
|
|
373
|
+
!toggle.contains(e.target)) {
|
|
374
|
+
sidebar.classList.remove('open');
|
|
375
|
+
}
|
|
376
|
+
});
|
|
377
|
+
</script>
|
|
378
|
+
|
|
379
|
+
</body>
|
|
380
|
+
</html>
|