Merge pull request #316 from knockout/docs/version-and-readmes

brianmhunt · web-flow · commit 622d2d06b5aa · 2026-04-15T18:21:44.000-04:00
Add version badge to tko.io and READMEs to all packages
diff --git a/builds/reference/README.md b/builds/reference/README.md
@@ -0,0 +1,5 @@
+# @tko/build.reference
+
+The TKO reference build — modern Knockout with TSX, native provider, and strict equality
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/builds/reference)
diff --git a/packages/bind/README.md b/packages/bind/README.md
@@ -0,0 +1,5 @@
+# @tko/bind
+
+TKO DOM-Observable Binding
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/bind)
diff --git a/packages/binding.component/README.md b/packages/binding.component/README.md
@@ -0,0 +1,5 @@
+# @tko/binding.component
+
+Component binding for web components
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/binding.component)
diff --git a/packages/binding.core/README.md b/packages/binding.core/README.md
@@ -0,0 +1,5 @@
+# @tko/binding.core
+
+Core bindings (text, html, css, style, attr, click, event, visible, etc.)
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/binding.core)
diff --git a/packages/binding.foreach/README.md b/packages/binding.foreach/README.md
@@ -0,0 +1,5 @@
+# @tko/binding.foreach
+
+Foreach binding for rendering collections
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/binding.foreach)
diff --git a/packages/binding.if/README.md b/packages/binding.if/README.md
@@ -0,0 +1,5 @@
+# @tko/binding.if
+
+Conditional bindings (if, ifnot, with, else)
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/binding.if)
diff --git a/packages/binding.template/README.md b/packages/binding.template/README.md
@@ -0,0 +1,5 @@
+# @tko/binding.template
+
+Template binding and template engines
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/binding.template)
diff --git a/packages/builder/README.md b/packages/builder/README.md
@@ -0,0 +1,5 @@
+# @tko/builder
+
+Build a customized TKO/Knockout instance from modular packages
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/builder)
diff --git a/packages/computed/README.md b/packages/computed/README.md
@@ -0,0 +1,5 @@
+# @tko/computed
+
+Computed observables and pure computeds
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/computed)
diff --git a/packages/filter.punches/README.md b/packages/filter.punches/README.md
@@ -0,0 +1,5 @@
+# @tko/filter.punches
+
+Expression filters for binding strings (from knockout punches)
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/filter.punches)
diff --git a/packages/lifecycle/README.md b/packages/lifecycle/README.md
@@ -0,0 +1,5 @@
+# @tko/lifecycle
+
+LifeCycle mixin for observable object instances
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/lifecycle)
diff --git a/packages/observable/README.md b/packages/observable/README.md
@@ -0,0 +1,5 @@
+# @tko/observable
+
+Observables, observable arrays, and subscriptions
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/observable)
diff --git a/packages/provider.attr/README.md b/packages/provider.attr/README.md
@@ -0,0 +1,5 @@
+# @tko/provider.attr
+
+Binding provider for ko-* HTML attributes
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/provider.attr)
diff --git a/packages/provider.bindingstring/README.md b/packages/provider.bindingstring/README.md
@@ -0,0 +1,5 @@
+# @tko/provider.bindingstring
+
+Abstract base class for providers that parse binding strings
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/provider.bindingstring)
diff --git a/packages/provider.component/README.md b/packages/provider.component/README.md
@@ -0,0 +1,5 @@
+# @tko/provider.component
+
+Binding provider for custom web components
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/provider.component)
diff --git a/packages/provider.databind/README.md b/packages/provider.databind/README.md
@@ -0,0 +1,5 @@
+# @tko/provider.databind
+
+Binding provider for data-bind HTML attributes
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/provider.databind)
diff --git a/packages/provider.multi/README.md b/packages/provider.multi/README.md
@@ -0,0 +1,5 @@
+# @tko/provider.multi
+
+Combine multiple binding providers into one
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/provider.multi)
diff --git a/packages/provider.mustache/README.md b/packages/provider.mustache/README.md
@@ -0,0 +1,5 @@
+# @tko/provider.mustache
+
+Mustache-style {{ interpolation }} in text and attributes
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/provider.mustache)
diff --git a/packages/provider.native/README.md b/packages/provider.native/README.md
@@ -0,0 +1,5 @@
+# @tko/provider.native
+
+Binding provider for values already attached to DOM nodes (TSX/JSX)
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/provider.native)
diff --git a/packages/provider.virtual/README.md b/packages/provider.virtual/README.md
@@ -0,0 +1,5 @@
+# @tko/provider.virtual
+
+Binding provider for `<!-- ko -->` virtual elements
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/provider.virtual)
diff --git a/packages/provider/README.md b/packages/provider/README.md
@@ -0,0 +1,5 @@
+# @tko/provider
+
+Abstract base class for binding providers
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/provider)
diff --git a/packages/utils.component/README.md b/packages/utils.component/README.md
@@ -0,0 +1,5 @@
+# @tko/utils.component
+
+Component registry, loaders, and ComponentABC base class
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/utils.component)
diff --git a/packages/utils.functionrewrite/README.md b/packages/utils.functionrewrite/README.md
@@ -0,0 +1,5 @@
+# @tko/utils.functionrewrite
+
+Rewrite function expressions as arrow functions
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/utils.functionrewrite)
diff --git a/packages/utils.jsx/README.md b/packages/utils.jsx/README.md
@@ -0,0 +1,5 @@
+# @tko/utils.jsx
+
+JSX/TSX rendering for TKO (createElement, JsxObserver)
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/utils.jsx)
diff --git a/packages/utils.parser/README.md b/packages/utils.parser/README.md
@@ -0,0 +1,5 @@
+# @tko/utils.parser
+
+CSP-safe expression parser for data-bind and ko-* attributes
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/utils.parser)
diff --git a/packages/utils/README.md b/packages/utils/README.md
@@ -0,0 +1,5 @@
+# @tko/utils
+
+Core utilities (DOM manipulation, arrays, events, tasks)
+
+Part of [TKO](https://tko.io) — modern Knockout.js. [Docs](https://tko.io) · [Source](https://github.com/knockout/tko/tree/main/packages/utils)
diff --git a/tko.io/src/components/Header.astro b/tko.io/src/components/Header.astro
@@ -1,5 +1,6 @@
 ---
 import config from 'virtual:starlight/user-config';
+import { readFileSync } from 'node:fs';
 
 import LanguageSelect from 'virtual:starlight/components/LanguageSelect';
 import Search from 'virtual:starlight/components/Search';
@@ -9,11 +10,15 @@ import ThemeSelect from 'virtual:starlight/components/ThemeSelect';
 
 const shouldRenderSearch =
 	config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro';
+
+const pkg = JSON.parse(readFileSync(new URL('../../../builds/knockout/package.json', import.meta.url), 'utf8'));
+const version = pkg.version;
 ---
 
 <div class="header">
 	<div class="title-wrapper sl-flex">
 		<SiteTitle />
+		<a class="version-badge" href={`https://github.com/knockout/tko/releases/tag/v${version}`}>v{version}</a>
 	</div>
 	<div class="sl-flex print:hidden">
 		{shouldRenderSearch && <Search />}
@@ -90,6 +95,25 @@ const shouldRenderSearch =
 			color: var(--sl-color-accent);
 		}
 
+		.version-badge {
+			display: inline-flex;
+			align-items: center;
+			padding: 0.15rem 0.5rem;
+			margin-inline-start: 0.5rem;
+			border-radius: 999px;
+			background: var(--sl-color-gray-6);
+			color: var(--sl-color-gray-2);
+			font-size: 0.72rem;
+			font-weight: 600;
+			text-decoration: none;
+			white-space: nowrap;
+		}
+
+		.version-badge:hover {
+			background: var(--sl-color-gray-5);
+			color: var(--sl-color-white);
+		}
+
 		@media (min-width: 50rem) {
 			:global(:root[data-has-sidebar]) {
 				--__sidebar-pad: calc(2 * var(--sl-nav-pad-x));
