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,497 @@
|
|
|
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>plugin.schema - 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">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 open><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" class="active">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="../../schemas/plugin-registry.schema.html">Schemas</a><span class="separator">›</span><a href="../../schemas/v0/common.schema.html">V0</a><span class="separator">›</span><span>plugin.schema</span></nav>
|
|
139
|
+
|
|
140
|
+
<h1>plugin.schema</h1>
|
|
141
|
+
<pre><code class="language-json">{
|
|
142
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
143
|
+
"$id": "https://kitfly.app/schemas/v0/plugin.schema.json",
|
|
144
|
+
"$version": "0.2.0",
|
|
145
|
+
"title": "Plugin Manifest",
|
|
146
|
+
"description": "Contract for kitfly plugins (plugin.yaml). Plugins are atomic (no plugin-to-plugin dependencies).",
|
|
147
|
+
"type": "object",
|
|
148
|
+
"required": [
|
|
149
|
+
"name",
|
|
150
|
+
"version",
|
|
151
|
+
"contract",
|
|
152
|
+
"description",
|
|
153
|
+
"license",
|
|
154
|
+
"kitfly",
|
|
155
|
+
"main"
|
|
156
|
+
],
|
|
157
|
+
"properties": {
|
|
158
|
+
"$schema": {
|
|
159
|
+
"type": "string",
|
|
160
|
+
"description": "Schema reference for validation"
|
|
161
|
+
},
|
|
162
|
+
"name": {
|
|
163
|
+
"type": "string",
|
|
164
|
+
"description": "Plugin identifier (used as registry key and folder name)",
|
|
165
|
+
"pattern": "^[a-z][a-z0-9-]*{{CONTENT}}quot;,
|
|
166
|
+
"minLength": 1,
|
|
167
|
+
"maxLength": 40,
|
|
168
|
+
"examples": [
|
|
169
|
+
"latex",
|
|
170
|
+
"callouts",
|
|
171
|
+
"slides-widgets"
|
|
172
|
+
]
|
|
173
|
+
},
|
|
174
|
+
"version": {
|
|
175
|
+
"$ref": "./common.schema.json#/$defs/semver"
|
|
176
|
+
},
|
|
177
|
+
"contract": {
|
|
178
|
+
"type": "string",
|
|
179
|
+
"description": "Plugin contract version this plugin implements (stringified integer)",
|
|
180
|
+
"pattern": "^[0-9]+{{CONTENT}}quot;,
|
|
181
|
+
"examples": [
|
|
182
|
+
"1"
|
|
183
|
+
]
|
|
184
|
+
},
|
|
185
|
+
"description": {
|
|
186
|
+
"type": "string",
|
|
187
|
+
"description": "Short human-readable description of the plugin",
|
|
188
|
+
"minLength": 1,
|
|
189
|
+
"maxLength": 140
|
|
190
|
+
},
|
|
191
|
+
"license": {
|
|
192
|
+
"type": "string",
|
|
193
|
+
"description": "License identifier (typically SPDX, e.g. MIT)",
|
|
194
|
+
"minLength": 1,
|
|
195
|
+
"maxLength": 50,
|
|
196
|
+
"examples": [
|
|
197
|
+
"MIT"
|
|
198
|
+
]
|
|
199
|
+
},
|
|
200
|
+
"kitfly": {
|
|
201
|
+
"$ref": "./common.schema.json#/$defs/semverRange"
|
|
202
|
+
},
|
|
203
|
+
"dependencies": {
|
|
204
|
+
"type": "object",
|
|
205
|
+
"description": "External resources required by the plugin (plugin-to-plugin dependencies are not allowed)",
|
|
206
|
+
"properties": {
|
|
207
|
+
"cdn": {
|
|
208
|
+
"type": "array",
|
|
209
|
+
"description": "External CDN resources (SRI integrity is required for every entry)",
|
|
210
|
+
"items": {
|
|
211
|
+
"$ref": "#/$defs/cdnResource"
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
},
|
|
215
|
+
"additionalProperties": false
|
|
216
|
+
},
|
|
217
|
+
"hooks": {
|
|
218
|
+
"type": "object",
|
|
219
|
+
"description": "Hook declarations (unknown hooks are invalid)",
|
|
220
|
+
"properties": {
|
|
221
|
+
"marked-extension": {
|
|
222
|
+
"type": "boolean",
|
|
223
|
+
"description": "Plugin provides a marked extension"
|
|
224
|
+
},
|
|
225
|
+
"template-head": {
|
|
226
|
+
"type": "boolean",
|
|
227
|
+
"description": "Plugin injects content into <head>"
|
|
228
|
+
},
|
|
229
|
+
"template-body-end": {
|
|
230
|
+
"type": "boolean",
|
|
231
|
+
"description": "Plugin injects content before </body>"
|
|
232
|
+
}
|
|
233
|
+
},
|
|
234
|
+
"additionalProperties": false
|
|
235
|
+
},
|
|
236
|
+
"main": {
|
|
237
|
+
"type": "string",
|
|
238
|
+
"description": "Plugin entry point (relative path within the plugin package)",
|
|
239
|
+
"pattern": "^[^\\0]+\\.(ts|js){{CONTENT}}quot;,
|
|
240
|
+
"examples": [
|
|
241
|
+
"index.ts"
|
|
242
|
+
]
|
|
243
|
+
},
|
|
244
|
+
"test-docs": {
|
|
245
|
+
"type": "array",
|
|
246
|
+
"description": "Glob patterns for validation corpus docs used in kitfly plugin testing",
|
|
247
|
+
"items": {
|
|
248
|
+
"type": "string",
|
|
249
|
+
"minLength": 1
|
|
250
|
+
},
|
|
251
|
+
"minItems": 1,
|
|
252
|
+
"examples": [
|
|
253
|
+
[
|
|
254
|
+
"test-docs/latex-samples/*.md"
|
|
255
|
+
]
|
|
256
|
+
]
|
|
257
|
+
},
|
|
258
|
+
"modes": {
|
|
259
|
+
"$ref": "./common.schema.json#/$defs/kitflyModesAllowlist"
|
|
260
|
+
}
|
|
261
|
+
},
|
|
262
|
+
"additionalProperties": false,
|
|
263
|
+
"$defs": {
|
|
264
|
+
"cdnResource": {
|
|
265
|
+
"type": "object",
|
|
266
|
+
"required": [
|
|
267
|
+
"url",
|
|
268
|
+
"integrity"
|
|
269
|
+
],
|
|
270
|
+
"properties": {
|
|
271
|
+
"url": {
|
|
272
|
+
"type": "string",
|
|
273
|
+
"description": "CDN URL (HTTPS required)",
|
|
274
|
+
"pattern": "^https://.+",
|
|
275
|
+
"minLength": 9
|
|
276
|
+
},
|
|
277
|
+
"integrity": {
|
|
278
|
+
"$ref": "./common.schema.json#/$defs/sriIntegrity"
|
|
279
|
+
}
|
|
280
|
+
},
|
|
281
|
+
"additionalProperties": false
|
|
282
|
+
}
|
|
283
|
+
},
|
|
284
|
+
"examples": [
|
|
285
|
+
{
|
|
286
|
+
"$schema": "./schemas/v0/plugin.schema.json",
|
|
287
|
+
"name": "latex",
|
|
288
|
+
"version": "1.0.0",
|
|
289
|
+
"contract": "1",
|
|
290
|
+
"description": "LaTeX/KaTeX math rendering",
|
|
291
|
+
"license": "MIT",
|
|
292
|
+
"kitfly": ">=0.2.0 <1.0.0",
|
|
293
|
+
"dependencies": {
|
|
294
|
+
"cdn": [
|
|
295
|
+
{
|
|
296
|
+
"url": "https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/katex.min.js",
|
|
297
|
+
"integrity": "sha384-abcDEF123+/="
|
|
298
|
+
},
|
|
299
|
+
{
|
|
300
|
+
"url": "https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/katex.min.css",
|
|
301
|
+
"integrity": "sha384-abcDEF123+/="
|
|
302
|
+
}
|
|
303
|
+
]
|
|
304
|
+
},
|
|
305
|
+
"hooks": {
|
|
306
|
+
"marked-extension": true,
|
|
307
|
+
"template-head": true
|
|
308
|
+
},
|
|
309
|
+
"main": "index.ts",
|
|
310
|
+
"test-docs": [
|
|
311
|
+
"test-docs/latex-samples/*.md"
|
|
312
|
+
]
|
|
313
|
+
}
|
|
314
|
+
]
|
|
315
|
+
}</code></pre>
|
|
316
|
+
</article>
|
|
317
|
+
|
|
318
|
+
</main>
|
|
319
|
+
</div>
|
|
320
|
+
|
|
321
|
+
<footer class="site-footer">
|
|
322
|
+
<div class="footer-content">
|
|
323
|
+
<div class="footer-left">
|
|
324
|
+
<span class="footer-version">v0.2.0</span>
|
|
325
|
+
<span class="footer-separator">·</span>
|
|
326
|
+
<span class="footer-commit" title="Commit: 33ccd68">Published 2026-02-15</span>
|
|
327
|
+
</div>
|
|
328
|
+
<div class="footer-center">
|
|
329
|
+
<span class="footer-copyright"><a href="https://3leaps.net" class="footer-link">© 2026 3 Leaps, LLC</a></span>
|
|
330
|
+
<span class="footer-separator">·</span><a href="/" class="footer-link">Kitfly</a>
|
|
331
|
+
</div>
|
|
332
|
+
<div class="footer-right">
|
|
333
|
+
<a href="https://kitfly.dev" class="footer-link">Built with Kitfly</a>
|
|
334
|
+
</div>
|
|
335
|
+
</div>
|
|
336
|
+
</footer>
|
|
337
|
+
<!-- Syntax highlighting - Prism.js -->
|
|
338
|
+
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-core.min.js"></script>
|
|
339
|
+
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/plugins/autoloader/prism-autoloader.min.js"></script>
|
|
340
|
+
<!-- Mermaid diagram support -->
|
|
341
|
+
<script type="module">
|
|
342
|
+
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
|
|
343
|
+
|
|
344
|
+
function getMermaidTheme() {
|
|
345
|
+
const theme = document.documentElement.getAttribute('data-theme');
|
|
346
|
+
const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
|
|
347
|
+
const isDark = theme === 'dark' || (!theme && prefersDark);
|
|
348
|
+
return isDark ? 'dark' : 'neutral';
|
|
349
|
+
}
|
|
350
|
+
|
|
351
|
+
mermaid.initialize({
|
|
352
|
+
startOnLoad: true,
|
|
353
|
+
theme: getMermaidTheme()
|
|
354
|
+
});
|
|
355
|
+
|
|
356
|
+
// Re-render mermaid diagrams when theme changes
|
|
357
|
+
window.reinitMermaid = async function() {
|
|
358
|
+
mermaid.initialize({ startOnLoad: false, theme: getMermaidTheme() });
|
|
359
|
+
const diagrams = document.querySelectorAll('.mermaid');
|
|
360
|
+
for (const el of diagrams) {
|
|
361
|
+
const code = el.getAttribute('data-mermaid-source');
|
|
362
|
+
if (code) {
|
|
363
|
+
el.innerHTML = code;
|
|
364
|
+
el.removeAttribute('data-processed');
|
|
365
|
+
}
|
|
366
|
+
}
|
|
367
|
+
await mermaid.run({ nodes: diagrams });
|
|
368
|
+
};
|
|
369
|
+
</script>
|
|
370
|
+
|
|
371
|
+
<script>
|
|
372
|
+
function toggleTheme() {
|
|
373
|
+
const html = document.documentElement;
|
|
374
|
+
const current = html.getAttribute('data-theme');
|
|
375
|
+
const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
|
|
376
|
+
|
|
377
|
+
let next;
|
|
378
|
+
if (current === 'dark') {
|
|
379
|
+
next = 'light';
|
|
380
|
+
} else if (current === 'light') {
|
|
381
|
+
next = 'dark';
|
|
382
|
+
} else {
|
|
383
|
+
// No explicit theme set, toggle from system preference
|
|
384
|
+
next = prefersDark ? 'light' : 'dark';
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
html.setAttribute('data-theme', next);
|
|
388
|
+
localStorage.setItem('theme', next);
|
|
389
|
+
|
|
390
|
+
// Switch Prism theme
|
|
391
|
+
const prismLight = document.getElementById('prism-light');
|
|
392
|
+
const prismDark = document.getElementById('prism-dark');
|
|
393
|
+
if (next === 'dark') {
|
|
394
|
+
prismLight?.setAttribute('disabled', '');
|
|
395
|
+
prismDark?.removeAttribute('disabled');
|
|
396
|
+
} else {
|
|
397
|
+
prismLight?.removeAttribute('disabled');
|
|
398
|
+
prismDark?.setAttribute('disabled', '');
|
|
399
|
+
}
|
|
400
|
+
|
|
401
|
+
// Re-render mermaid diagrams with new theme
|
|
402
|
+
if (window.reinitMermaid) {
|
|
403
|
+
window.reinitMermaid();
|
|
404
|
+
}
|
|
405
|
+
}
|
|
406
|
+
|
|
407
|
+
// Slides mode hash routing
|
|
408
|
+
(function initSlidesMode() {
|
|
409
|
+
const shell = document.querySelector('.slides-shell');
|
|
410
|
+
if (!shell) return;
|
|
411
|
+
|
|
412
|
+
const slides = Array.from(document.querySelectorAll('.slide'));
|
|
413
|
+
if (!slides.length) return;
|
|
414
|
+
|
|
415
|
+
const prevBtn = document.querySelector('.slide-prev');
|
|
416
|
+
const nextBtn = document.querySelector('.slide-next');
|
|
417
|
+
const counter = document.querySelector('.slide-counter');
|
|
418
|
+
const progressBar = document.querySelector('.slide-progress-bar');
|
|
419
|
+
const navLinks = Array.from(document.querySelectorAll('.sidebar-nav a[href^="#slide-"]'));
|
|
420
|
+
let current = 0;
|
|
421
|
+
|
|
422
|
+
function setActive(n) {
|
|
423
|
+
current = Math.max(0, Math.min(n, slides.length - 1));
|
|
424
|
+
slides.forEach((slide, idx) => slide.classList.toggle('active', idx === current));
|
|
425
|
+
navLinks.forEach((link) => {
|
|
426
|
+
const active = link.getAttribute('href') === '#' + slides[current].id;
|
|
427
|
+
link.classList.toggle('active', active);
|
|
428
|
+
});
|
|
429
|
+
if (counter) counter.textContent = (current + 1) + ' / ' + slides.length;
|
|
430
|
+
if (progressBar) progressBar.style.width = (((current + 1) / slides.length) * 100) + '%';
|
|
431
|
+
if (prevBtn) prevBtn.disabled = current === 0;
|
|
432
|
+
if (nextBtn) nextBtn.disabled = current === slides.length - 1;
|
|
433
|
+
history.replaceState(null, '', '#' + slides[current].id);
|
|
434
|
+
}
|
|
435
|
+
|
|
436
|
+
function setFromHash() {
|
|
437
|
+
const hash = window.location.hash || '';
|
|
438
|
+
const idx = slides.findIndex((s) => '#' + s.id === hash);
|
|
439
|
+
if (idx >= 0) setActive(idx);
|
|
440
|
+
else setActive(0);
|
|
441
|
+
}
|
|
442
|
+
|
|
443
|
+
prevBtn?.addEventListener('click', () => setActive(current - 1));
|
|
444
|
+
nextBtn?.addEventListener('click', () => setActive(current + 1));
|
|
445
|
+
|
|
446
|
+
document.addEventListener('keydown', (e) => {
|
|
447
|
+
if (e.key === 'ArrowRight' || e.key === ' ') {
|
|
448
|
+
e.preventDefault();
|
|
449
|
+
setActive(current + 1);
|
|
450
|
+
} else if (e.key === 'ArrowLeft') {
|
|
451
|
+
e.preventDefault();
|
|
452
|
+
setActive(current - 1);
|
|
453
|
+
} else if (e.key === 'Home') {
|
|
454
|
+
e.preventDefault();
|
|
455
|
+
setActive(0);
|
|
456
|
+
} else if (e.key === 'End') {
|
|
457
|
+
e.preventDefault();
|
|
458
|
+
setActive(slides.length - 1);
|
|
459
|
+
}
|
|
460
|
+
});
|
|
461
|
+
|
|
462
|
+
window.addEventListener('hashchange', setFromHash);
|
|
463
|
+
setFromHash();
|
|
464
|
+
})();
|
|
465
|
+
|
|
466
|
+
// Copy code button
|
|
467
|
+
document.querySelectorAll('.prose pre code').forEach(block => {
|
|
468
|
+
const button = document.createElement('button');
|
|
469
|
+
button.className = 'copy-button';
|
|
470
|
+
button.textContent = 'Copy';
|
|
471
|
+
button.onclick = async () => {
|
|
472
|
+
await navigator.clipboard.writeText(block.textContent);
|
|
473
|
+
button.textContent = 'Copied!';
|
|
474
|
+
setTimeout(() => button.textContent = 'Copy', 2000);
|
|
475
|
+
};
|
|
476
|
+
block.parentElement.appendChild(button);
|
|
477
|
+
});
|
|
478
|
+
|
|
479
|
+
// Mobile nav toggle
|
|
480
|
+
function toggleNav() {
|
|
481
|
+
document.querySelector('.sidebar').classList.toggle('open');
|
|
482
|
+
}
|
|
483
|
+
|
|
484
|
+
// Close nav when clicking outside on mobile
|
|
485
|
+
document.addEventListener('click', (e) => {
|
|
486
|
+
const sidebar = document.querySelector('.sidebar');
|
|
487
|
+
const toggle = document.querySelector('.nav-toggle');
|
|
488
|
+
if (sidebar.classList.contains('open') &&
|
|
489
|
+
!sidebar.contains(e.target) &&
|
|
490
|
+
!toggle.contains(e.target)) {
|
|
491
|
+
sidebar.classList.remove('open');
|
|
492
|
+
}
|
|
493
|
+
});
|
|
494
|
+
</script>
|
|
495
|
+
|
|
496
|
+
</body>
|
|
497
|
+
</html>
|