@norskvideo/ctl-dev-kit 0.2.2 → 0.2.4

package/create-product/turnkey.ts

@@ -14,6 +14,7 @@
 // validate(), INVARIANTS + parity + byte-snapshot + studio-load wired into
 // test:unit, and an image smoke tier.
 import { type GeneratedFile, type ShapeContext, type ShapeModule, studioPackage } from "./create-product.ts";
+import { DOCS_SITE_GITIGNORE, DOCS_SITE_SCRIPTS, docsSiteFiles } from "./docs-site.ts";
 import {
   COMPONENTS_GITIGNORE,
   componentsFiles,
@@ -188,6 +189,32 @@ fresh image and checks the pins before relaunching.
 6. \`bun run docs:handover\` — once a daemon has this product added; fills the
    handover's generated block from the launch truth.
 
+## The docs site (\`website/\`)
+
+A **standalone package**, deliberately outside the root \`workspaces\` array:
+Astro's dependency tree has no business in the product's install. Two
+consequences that bite in that order —
+
+- \`bun install\` at the root does NOT install it. \`bun install --cwd website\`
+  does, once; then \`bun run docs:dev\` / \`bun run docs:site\`.
+- \`website/src/starlight.ts\`, \`website/src/custom.css\`,
+  \`website/src/content.config.ts\`, \`website/src/components/\`,
+  \`website/src/fonts/\` and \`website/public/favicon.png\` are **copies of the
+  dev-kit's shared theme**, not this repo's files. \`bun run check:drift\`
+  fails on a hand-edited one; \`bun run sync:drift\` rewrites them. A styling or
+  layout change belongs in the dev-kit, where it reaches every product's manual.
+
+This repo owns four things: the origin (\`website/src/lib/site.ts\`), the two
+names and the sidebar (\`website/astro.config.mjs\`), and the content
+(\`website/src/content/docs/\`). Keep the five top-level sections — Start here,
+Guides, How-to, Concepts, Reference — they are what make several Norsk manuals
+navigable by one reader. The placeholder pages say what belongs in each.
+
+It is NOT the bundle the image serves at /docs (\`bun run docs:manual\`); both
+channels exist on purpose, and the dev-kit's
+\`node_modules/@norskvideo/ctl-dev-kit/conventions/docs-site.md\` says which to
+reach for.
+
 ## Version pins
 
 Media + Studio container tags derive from **\`manifest.seed.json\`** (the
@@ -273,6 +300,9 @@ function rootPackageJson(ctx: ShapeContext): string {
         "docs:manual": `bun run node_modules/@norskvideo/ctl-dev-kit/doc-guide/prose-bundle.js --brand "${ctx.name}" --title "${ctx.name} — Documentation" --link "norsk.video=https://norsk.video/" --out docs/generated/bundle docs/handover.md docs/known-limitations.md`,
         "docs:handover": "bash scripts/docs-handover.sh",
         "docs:handover:check": "bash scripts/docs-handover.sh --check",
+        // The docs SITE (website/) — a standalone package, so its install is its
+        // own: `bun install --cwd website` before the first build.
+        ...DOCS_SITE_SCRIPTS,
         "sync:drift": "bun run node_modules/@norskvideo/ctl-dev-kit/conventions/sync-drift.ts",
         // codegen first: components/_gen/types.ts is gitignored build output,
         // so on a clean checkout tsc has nothing to resolve against without it.
@@ -1880,6 +1910,7 @@ ${optional}- \`backend/\` — the control-plane service (manifest, product-templ
 - \`examples/\` — starter configs; \`examples/default/input.json\` is the default template.
 - \`tests/\` — unit, image and demo tiers; \`tests/demo.spec.ts\` is the customer journey.
 - \`docs/\` — reader-facing documents; \`docs/README.md\` is the index.
+- \`website/\` — the public docs site (Astro + Starlight on the shared Norsk theme).
 - \`deployment/\` — the image build wrapper and the iterate loop.
 
 ## First run
@@ -1903,11 +1934,20 @@ norsk-ctl and the pinned Norsk SDK:
 
 ## Documentation
 
-\`bun run docs:manual\` builds the docs bundle from \`docs/handover.md\` and
-\`docs/known-limitations.md\`; the image build runs it, so every image serves
-them at /docs (linked from the product's page in norsk-ctl). \`bun run
-docs:handover\` regenerates the handover's generated block from a daemon that
-has this product added; CI runs its \`--check\`.
+Two channels, deliberately:
+
+- **The bundle the image serves.** \`bun run docs:manual\` builds it from
+  \`docs/handover.md\` and \`docs/known-limitations.md\`; the image build runs
+  it, so every image serves them at /docs at the version that is running
+  (linked from the product's page in norsk-ctl). \`bun run docs:handover\`
+  regenerates the handover's generated block from a daemon that has this
+  product added; CI runs its \`--check\`.
+- **The docs site**, \`website/\` — the public manual on the shared Norsk theme,
+  five sections deep, faster-moving and readable without the product in hand.
+  \`bun install --cwd website\` once, then \`bun run docs:dev\` /
+  \`bun run docs:site\`. \`website/README.md\` says what is the site's and what
+  is the theme's; the dev-kit's
+  \`node_modules/@norskvideo/ctl-dev-kit/conventions/docs-site.md\` is the contract.
 
 \`CLAUDE.md\` has the conventions and the traps.
 `;
@@ -1924,6 +1964,10 @@ served at /docs at the version that is running.
 | \`docs/handover.md\`          | the platform team deploying this product  | Deploying from the exported bundle without norsk-ctl: every mount, environment and injected setting |
 | \`docs/known-limitations.md\` | operators                                 | What the product does not do yet, with the consequence and the workaround                          |
 
+The **docs site** is a separate channel and lives in \`website/\`: the public
+manual, on the shared Norsk theme, not built from these files. See
+\`website/README.md\`.
+
 \`bun run docs:manual\` builds the bundle from these files. The tables in the
 handover are generated by norsk-ctl (\`bun run docs:handover\`) — regenerate
 them, never edit them.
@@ -2012,6 +2056,7 @@ function gitignoreTail(ctx: ShapeContext): string {
   const blocks = ["# Repo-specific entries go below (the block above is drift-gated verbatim).\n"];
   if (ctx.features.has("components")) blocks.push(COMPONENTS_GITIGNORE);
   if (ctx.features.has("dashboard")) blocks.push(DASHBOARD_GITIGNORE);
+  blocks.push(DOCS_SITE_GITIGNORE);
   return blocks.join("\n");
 }
 
@@ -2033,6 +2078,7 @@ export const turnkey: ShapeModule = {
       { path: "deployment/iterate.sh", content: iterateSh(ctx), executable: true },
       { path: "scripts/demo", content: ctx.canon.demoShim, executable: true },
       { path: "README.md", content: readmeMd(ctx) },
+      ...docsSiteFiles(ctx),
       { path: "docs/README.md", content: docsReadmeMd(ctx) },
       { path: "docs/handover.md", content: handoverMd(ctx) },
       { path: "docs/known-limitations.md", content: KNOWN_LIMITATIONS_MD },

package/docs-theme/README.md

@@ -0,0 +1,106 @@
+# `docs-theme/` — the shared Norsk docs site theme
+
+The parts of an Astro + Starlight docs site that must **never** differ between
+Norsk products: the theme, the three component overrides, the content schema,
+and the Astro/Starlight configuration itself. A product's site owns only what
+genuinely differs — its content, its sidebar, its origin and its two names.
+
+    custom.css              the palette + self-hosted Geist faces
+    fonts/                  the woff2 those @font-face rules point at
+    public/favicon.png      the favicon `starlight.ts` names (copied to the site ROOT, not src/)
+    components/Footer.astro    the "captured against" line on a generated guide
+    components/Sidebar.astro   the "Built against" versions footer
+    components/SiteTitle.astro the masthead wordmark, decoupled from the tab title
+    content.config.ts       the docs collection, incl. `capturedAgainst`
+    starlight.ts            `norskDocsSite()` — the whole Astro config bar the site's own parts
+    sync.ts                 the writer and the drift gate
+
+## Consuming it
+
+A docs site's `astro.config.mjs` becomes its sidebar plus five lines:
+
+```js
+import { defineConfig } from "astro/config";
+import { isPublicBuild, norskDocsSite } from "./src/starlight.ts";
+
+export default defineConfig(
+  norskDocsSite({
+    origin: "https://ctl.norsk.video",
+    tabTitle: "Norsk",              // browser tab suffix — tabs truncate
+    wordmark: "norsk-ctl",          // masthead — names the tool in hand
+    buildVersions: [{ label: "norsk-ctl", value: version }],
+    sidebar: [...],
+  }),
+);
+```
+
+`norskDocsSite()` supplies the two-build shape (`dist-embedded` at base `/docs`
+for the copy baked into a product binary, `dist-public` at base `/` for the
+site on its own domain, selected by `ASTRO_BUILD=public`), the /docs-prefix
+strip that makes the public build's absolute links work, the mermaid pipeline,
+the favicon convention, and the component + CSS wiring.
+
+## Why the files are copied into the site, not imported from here
+
+A docs site is a **standalone package** — its own `bun.lock`, its own
+`node_modules`, outside the monorepo's workspaces, because Astro's dependency
+tree has no business in a product install. It therefore cannot depend on this
+package the way every other dev-kit consumer does. That is measured, not
+assumed: adding `"@norskvideo/ctl-dev-kit": "file:../../dev-kit"` to norsk-ctl's
+website and installing fails with
+
+    error: @norskvideo/ctl-sdk@workspace:* failed to resolve
+
+because bun must then resolve this package's own `workspace:*` dependencies
+from a directory that is not in a workspace.
+
+So the theme is a **forced copy**, handled the way this package already handles
+every forced copy — canonical bytes here, a writer, and a gate:
+
+```
+bun node_modules/@norskvideo/ctl-dev-kit/docs-theme/sync.ts sync  <site>
+bun node_modules/@norskvideo/ctl-dev-kit/docs-theme/sync.ts check <site>
+```
+
+`<site>` is the directory holding `astro.config.mjs`; the copies land in its
+`src/`, so this directory mirrors a site's `src/` and the path map is an
+identity. The one exception is `public/`, which mirrors the site's `public/` —
+Astro serves it verbatim from the site root, and `starlight.ts` already dictates
+the favicon's path (`favicon: "/favicon.png"`), so its bytes belong here too.
+
+A site runs `check` in its own test suite (norsk-ctl:
+`website/tests/theme-drift.test.ts`, which `bun run check` runs), so a
+hand-edited copy fails before it is published. A PRODUCT repo has no such suite;
+there, `conventions/check-drift.ts` runs the same check as part of
+`bun run check:drift`, and `sync-drift.ts` rewrites the copies as part of
+`bun run sync:drift` — see below.
+
+**Keeping the copies at those exact paths is load-bearing.** Astro derives a
+component's scoped-style class from its path, so moving `Footer.astro` rewrites
+a class attribute on every page of the site.
+
+## The two gates are one gate
+
+`conventions/check-drift.ts` gains a clause when — and only when — the repo has a
+site: `hasDocsSite()` tests for `website/astro.config.mjs`, and
+`docsThemeProblems()` routes this directory's `checkTheme` into the same report as
+`biome.json` and the shared workflows. `conventions/sync-drift.ts` is the writer
+half, so `sync-dev-kit.yml` rolls a theme change out to every product hands-free
+like any other convention. The site directory is `website/` across the fleet
+(`DOCS_SITE_DIR`).
+
+A site inside THIS monorepo still runs `sync.ts check` from its own test suite,
+because it has one and because `bun run check` is what a monorepo contributor
+runs; a product repo has no second suite, which is why the clause exists.
+
+## `create-product` renders a site
+
+Every generated repo comes out with a `website/` on this theme, five sections
+deep, that builds — `create-product/docs-site.ts`. Two notes on how:
+
+- the theme files are written by **this directory's `syncTheme`**, called from
+  `createProduct` after the plan is written, not re-rendered by the generator: one
+  copier, one gate, and the woff2 faces are not strings;
+- what a product repo needs in order to have a site at all — the five sections,
+  the two builds, publishing, and how the site relates to the illustrated manual
+  the image serves — is `conventions/docs-site.md`.

package/docs-theme/components/Footer.astro

@@ -0,0 +1,40 @@
+---
+/**
+ * Starlight's footer plus the "captured against" line on a generated guide.
+ *
+ * The test-driven guides every Norsk docs site carries are captured by a
+ * Playwright run against a real stack and republished from a cache, so a page
+ * can be older than the product it documents — some guides ride every release,
+ * the expensive ones a weekly run. The shared renderer writes what the run knew
+ * into the page's front matter (`capturedAgainst`, see content.config.ts) and
+ * this says it on the page: "Captured 2026-09-17 against norsk-mgr 0.1.0-…". A
+ * page without the field (hand-written, or captured before the field existed)
+ * shows nothing extra.
+ */
+import Default from "@astrojs/starlight/components/Footer.astro";
+
+const against = Astro.locals.starlightRoute.entry.data.capturedAgainst;
+const parts: string[] = [];
+if (against?.norskMgr) parts.push(`norsk-mgr ${against.norskMgr}`);
+if (against?.norsk) parts.push(`Norsk Manager ${against.norsk}`);
+const line = against ? `Captured ${against.when}${parts.length ? ` against ${parts.join(", ")}` : ""}` : null;
+---
+
+{
+	line && (
+		<p class="captured-against">
+			{line} — every command and screenshot on this page is from that run.
+		</p>
+	)
+}
+<Default><slot /></Default>
+
+<style>
+	.captured-against {
+		margin-top: 3rem;
+		padding-top: 1rem;
+		border-top: 1px solid var(--sl-color-hairline-light);
+		font-size: var(--sl-text-sm);
+		color: var(--sl-color-gray-3);
+	}
+</style>

package/docs-theme/components/Sidebar.astro

@@ -0,0 +1,73 @@
+---
+/**
+ * Starlight's sidebar plus a footer stating what this docs build was built
+ * against. Every product site wants this line and none of them should word it
+ * differently, so the markup is shared and only the rows differ: the site
+ * passes them to `norskDocsSite({ buildVersions })`, which injects them as
+ * `__BUILD_VERSIONS__` (see starlight.ts on why a vite define rather than an
+ * import). They are read at build time from the product's own files, so they
+ * cannot drift from what ships the way a hand-written literal in MDX did.
+ */
+import Default from "@astrojs/starlight/components/Sidebar.astro";
+
+// Injected by vite.define in starlight.ts — see the note there on why this is
+// not resolved from within the component.
+declare const __BUILD_VERSIONS__: Array<{ label: string; value: string; splitOnLastColon?: boolean }>;
+// The repo/tag split keeps a long image pin wrapping sensibly in a narrow
+// sidebar: `norskvideo/x:tag` breaks after the colon rather than mid-word.
+const rows = __BUILD_VERSIONS__.map((v) => ({
+  label: v.label,
+  parts: v.splitOnLastColon ? v.value.split(/:(?=[^:]*$)/) : [v.value],
+}));
+---
+
+<Default><slot /></Default>
+
+<div class="build-versions">
+	<p class="build-versions__heading">Built against</p>
+	<dl>
+		{/* One line per row on purpose: whitespace between expressions inside a
+		    template expression survives into the emitted <code>, and a stray
+		    space in the middle of an image pin is a rendering change. */}
+		{rows.map((row) => (
+			<Fragment><dt>{row.label}</dt><dd><code>{row.parts[0]}{row.parts.length > 1 && <Fragment>:<wbr />{row.parts[1]}</Fragment>}</code></dd></Fragment>
+		))}
+	</dl>
+</div>
+
+<style>
+	.build-versions {
+		margin-top: 1.5rem;
+		padding-top: 1rem;
+		border-top: 1px solid var(--sl-color-hairline-light);
+		font-size: var(--sl-text-xs);
+		color: var(--sl-color-gray-3);
+	}
+
+	.build-versions__heading {
+		margin: 0 0 0.5rem;
+		font-weight: 600;
+		text-transform: uppercase;
+		letter-spacing: 0.05em;
+		color: var(--sl-color-gray-2);
+	}
+
+	.build-versions dl {
+		margin: 0;
+	}
+
+	.build-versions dt {
+		margin-top: 0.5rem;
+	}
+
+	.build-versions dd {
+		margin: 0.125rem 0 0;
+	}
+
+	.build-versions code {
+		font-size: var(--sl-text-xs);
+		overflow-wrap: anywhere;
+		background: none;
+		padding: 0;
+	}
+</style>

package/docs-theme/components/SiteTitle.astro

@@ -0,0 +1,52 @@
+---
+/**
+ * The masthead wordmark, top-left of every page.
+ *
+ * Exists only to say something different from `starlight.title`. Starlight
+ * drives the masthead and the browser-tab suffix from that single value, and
+ * the two want different things: the tab wants the short family name because
+ * tabs truncate, the masthead wants to name the tool the reader is holding.
+ * `norskDocsSite({ tabTitle, wordmark })` is where a site says both, and the
+ * wordmark reaches here as `__SITE_WORDMARK__`.
+ *
+ * The wordmark is the binary name, deliberately. Everything under it — the
+ * sidebar, the commands, the paths — says the binary's name, and a masthead
+ * reading anything else would be a second name for one thing: it splits
+ * searches and makes the reader learn a mapping. How to SAY it is a real
+ * question, and it is answered in prose on the index page rather than by
+ * renaming the product.
+ *
+ * Not a wrapper around Starlight's own SiteTitle, because the text it renders
+ * comes from `Astro.locals.starlightRoute.siteTitle` and mutating that would
+ * also move the <title> — the exact coupling this override is here to break.
+ * Reimplemented instead, which is cheap: the upstream component is a link, a
+ * span and some logo handling, and no logo is configured here.
+ */
+declare const __SITE_WORDMARK__: string;
+
+const { siteTitleHref } = Astro.locals.starlightRoute;
+---
+
+<a href={siteTitleHref} class="site-title sl-flex">
+	<span translate="no">{__SITE_WORDMARK__}</span>
+</a>
+
+<style>
+	/* Mirrors upstream SiteTitle.astro. Same layer, so a Starlight upgrade that
+	   restyles the masthead still applies here. */
+	@layer starlight.core {
+		.site-title {
+			align-items: center;
+			gap: var(--sl-nav-gap);
+			font-size: var(--sl-text-h4);
+			font-weight: 600;
+			color: var(--sl-color-text-accent);
+			text-decoration: none;
+			white-space: nowrap;
+			min-width: 0;
+		}
+		span {
+			overflow: hidden;
+		}
+	}
+</style>

package/docs-theme/content.config.ts

@@ -0,0 +1,25 @@
+import { defineCollection, z } from "astro:content";
+import { docsLoader } from "@astrojs/starlight/loaders";
+import { docsSchema } from "@astrojs/starlight/schema";
+
+// The docs content collection every Norsk product site declares. Shared so a
+// page authored for one site is loadable by another and the guide renderer has
+// one schema to satisfy.
+//
+// `capturedAgainst` is what the test-driven guides' renderer writes into a
+// generated page's front matter (`renderMarkdown` in the shared guide
+// renderer): the versions the page was captured against and the capture date.
+// Footer.astro renders it; a hand-written page simply has none. Strings, not
+// dates — the renderer quotes them for exactly that reason.
+export const capturedAgainstSchema = z.object({
+  norsk: z.string().optional(),
+  norskMgr: z.string().optional(),
+  when: z.string(),
+});
+
+export const collections = {
+  docs: defineCollection({
+    loader: docsLoader(),
+    schema: docsSchema({ extend: z.object({ capturedAgainst: capturedAgainstSchema.optional() }) }),
+  }),
+};

package/docs-theme/custom.css

@@ -0,0 +1,108 @@
+/* Match the norsk-ctl frontend's Tailwind zinc palette. */
+
+/*
+ * Self-hosted Geist Sans + Mono, byte-identical to @norskvideo/ctl-sdk/base.css so the
+ * docs chrome renders in the same face as the app and the guide screenshots.
+ * Standalone package — it can't @import the SDK's base.css, so it vendors the
+ * woff2 (see src/fonts/README obligations). Relative url() → Vite fingerprints
+ * them into the build; never a CDN.
+ */
+@font-face {
+  font-family: "Geist";
+  font-style: normal;
+  font-weight: 100 900; /* variable range → no faux bold */
+  font-display: swap;
+  src: url("./fonts/Geist.woff2") format("woff2-variations"),
+       url("./fonts/Geist.woff2") format("woff2");
+}
+
+@font-face {
+  font-family: "Geist Mono";
+  font-style: normal;
+  font-weight: 100 900;
+  font-display: swap;
+  src: url("./fonts/GeistMono.woff2") format("woff2-variations"),
+       url("./fonts/GeistMono.woff2") format("woff2");
+}
+
+:root {
+  --sl-font: "Geist", ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
+  --sl-font-mono: "Geist Mono", ui-monospace, "SF Mono", "Cascadia Code", "Fira Code", Menlo, Consolas, monospace;
+}
+
+/* Dark theme — primary. Tailwind zinc + indigo accent matching the React app. */
+:root[data-theme="dark"] {
+  /* Backgrounds */
+  --sl-color-bg: #18181b;               /* zinc-900 */
+  --sl-color-bg-nav: #1f1f23;           /* zinc-850 */
+  --sl-color-bg-sidebar: #1f1f23;       /* zinc-850 */
+  --sl-color-bg-inline-code: #27272a;   /* zinc-800 */
+  --sl-color-bg-accent: #818cf8;        /* indigo-400 */
+
+  /* Text */
+  --sl-color-text: #e4e4e7;             /* zinc-200 */
+  --sl-color-text-accent: #a5b4fc;      /* indigo-300 */
+  --sl-color-text-invert: #18181b;      /* zinc-900 */
+
+  /* Gray ramp */
+  --sl-color-white: #fafafa;            /* zinc-50 */
+  --sl-color-gray-1: #e4e4e7;           /* zinc-200 */
+  --sl-color-gray-2: #a1a1aa;           /* zinc-400 */
+  --sl-color-gray-3: #71717a;           /* zinc-500 */
+  --sl-color-gray-4: #52525b;           /* zinc-600 */
+  --sl-color-gray-5: #3f3f46;           /* zinc-700 */
+  --sl-color-gray-6: #27272a;           /* zinc-800 */
+  --sl-color-black: #18181b;            /* zinc-900 */
+
+  /* Accent */
+  --sl-color-accent-low: #1e1b4b;       /* indigo-950 */
+  --sl-color-accent: #6366f1;           /* indigo-500 */
+  --sl-color-accent-high: #c7d2fe;      /* indigo-200 */
+
+  /* Hairlines */
+  --sl-color-hairline-light: #27272a;   /* zinc-800 */
+  --sl-color-hairline: #3f3f46;         /* zinc-700 */
+  --sl-color-hairline-shade: #52525b;   /* zinc-600 */
+}
+
+/* Light theme — reasonable defaults, zinc-tinted. */
+:root {
+  --sl-color-accent-low: #eef2ff;       /* indigo-50 */
+  --sl-color-accent: #4f46e5;           /* indigo-600 */
+  --sl-color-accent-high: #312e81;      /* indigo-900 */
+  --sl-color-hairline-light: #e4e4e7;   /* zinc-200 */
+  --sl-color-hairline: #d4d4d8;         /* zinc-300 */
+}
+
+/* Scrollbars — mirror frontend. */
+::-webkit-scrollbar {
+  width: 6px;
+  height: 6px;
+}
+::-webkit-scrollbar-track {
+  background: #18181b;
+}
+::-webkit-scrollbar-thumb {
+  background: #3f3f46;
+  border-radius: 3px;
+}
+
+/* Nav title weight + tracking to match the app brand. */
+.site-title {
+  font-weight: 700 !important;
+  letter-spacing: -0.02em;
+}
+
+/* Tighter heading tracking. */
+h1 { letter-spacing: -0.035em; }
+h2 { letter-spacing: -0.025em; }
+h3 { letter-spacing: -0.015em; }
+
+/* Cards — rounded, accent on hover. */
+.sl-link-card,
+.card {
+  border-radius: 12px;
+}
+.sl-link-card:hover {
+  border-color: var(--sl-color-accent);
+}

package/docs-theme/fonts/Geist-LICENSE.txt

@@ -0,0 +1,92 @@
+Copyright (c) 2023 Vercel, in collaboration with basement.studio
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION AND CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.