@kensio/colophon 0.2.0 → 2.1.0

package/README.md

@@ -10,6 +10,8 @@ finished work.
 
 - **Frontmatter-driven** — general props read from a post, not a fixed schema.
 - **Templates** — a small registry of layouts; frontmatter picks one.
+- **Syntax-highlighted code images** — the `code` template renders a snippet
+  from frontmatter with real VS Code theme colours.
 - **Configurable branding** — colours, gradient, fonts, footer and badge come
   from config, not from any one site's stylesheet.
 - **Multiple sizes from one input** — a 1:1 square plus a 1.91:1 landscape by
@@ -23,7 +25,8 @@ finished work.
 pnpm add @kensio/colophon
 ```
 
-`sharp` is a dependency and does the SVG → PNG rasterisation.
+`sharp` is a dependency and does the SVG → PNG rasterisation; `shiki` provides
+the grammars and themes for the `code` template.
 
 ## Quick start (CLI)
 
@@ -59,9 +62,10 @@ Run it over a content tree:
 colophon content --config colophon.config.ts
 ```
 
-For every file that declares `meta_img_props`, Colophon writes a PNG next to it
-(`post/index.md` → `post/post.png`, plus `post/post-1200x630.png` for the extra
-size). Existing files are skipped unless you pass `--overwrite`.
+For every file that declares `meta_img_props`, Colophon writes one PNG per
+output size next to it, named `<slug>-<size>.png`
+(`post/index.md` → `post/post-og.png` and `post/post-square.png`). Existing
+files are skipped unless you pass `--overwrite`.
 
 ```
 colophon [contentDir] [options]
@@ -99,8 +103,8 @@ const images = await renderMetaImages(
 );
 
 for (const image of images) {
-  const { width, height } = image.dimensions;
-  await writeFile(`card-${width}x${height}.png`, image.png);
+  // image.name is the output-size name ("og", "square", …).
+  await writeFile(`social-${image.name}.png`, image.png);
 }
 ```
 
@@ -130,10 +134,74 @@ only want frontmatter discovery.
 | -------- | ---------------------------------------------------------------------------- |
 | `banner` | Left-aligned title with optional version, subtitle, corner badge and footer. |
 | `card`   | Minimal centred title with an optional subtitle.                             |
+| `code`   | Syntax-highlighted snippet on a rounded panel over the background.           |
 
 Register your own by passing `templates` in config — a template is `{ name,
-render(context) }` returning SVG foreground content. Anything you add merges
-over (and can override) the built-ins.
+render(context) }` returning SVG foreground content, either directly or as a
+promise. Anything you add merges over (and can override) the built-ins.
+
+### The `code` template
+
+Put the snippet in frontmatter and name its language:
+
+```yaml
+---
+title: eslint changed TypeScript files only
+slug: eslint-changed-ts-files-only
+meta_img_props:
+  template: code
+  language: bash
+  code: |
+    mapfile -t CHANGED_TS < <(
+      git diff origin/main --name-only \
+        | grep '\.ts'
+    )
+---
+```
+
+| Prop       | Notes                                                                |
+| ---------- | -------------------------------------------------------------------- |
+| `code`     | The snippet. Surrounding blank lines are trimmed; tabs are expanded. |
+| `language` | Any [Shiki language]; unknown names fall back to plain text.         |
+| `title`    | Optional heading above the panel. Omit for a bare code image.        |
+| `theme`    | Optional per-post override of `config.code.theme`.                   |
+
+[Shiki language]: https://shiki.style/languages
+
+Pygments-style names carried over from an older pipeline (`text`, `console`,
+`html+handlebars`, …) are mapped onto their Shiki equivalents, so existing
+frontmatter usually needs no changes.
+
+The font size is fitted to the snippet: Colophon measures the longest line and
+the line count against a monospace grid and picks the largest size that fits on
+both axes, within `minFontScale`/`maxFontScale`. Code too long to fit legibly is
+truncated with an ellipsis rather than shrunk into unreadability. The panel then
+shrinks vertically onto the result so short snippets aren't left floating.
+
+Styling comes from `config.code`:
+
+```ts
+export default defineConfig({
+  colors: { brand: "#2563eb" },
+  footer: "example.com",
+  code: {
+    theme: "night-owl", // any bundled Shiki theme
+    fontFamily: '"JetBrains Mono", monospace',
+    charWidthRatio: 0.6, // glyph advance ÷ font size, for your monospace face
+    lineHeight: 1.55,
+    tabSize: 2,
+    cornerScale: 0.025,
+    maxFontScale: 0.075,
+    minFontScale: 0.018,
+  },
+});
+```
+
+`charWidthRatio` is how the layout knows where each token sits, so it must match
+the font actually used — `0.6` suits most monospace faces (Source Code Pro,
+Menlo, DejaVu Sans Mono); Consolas wants about `0.55`. Fonts must be installed
+where `sharp` can see them; the default stack ends in the generic `monospace`
+family so it always resolves to something.
 
 ## Configuration
 
@@ -146,14 +214,45 @@ All fields are optional; sensible defaults apply.
 | `fontFamily` | `Arial, Helvetica, sans-serif` | Uses fonts available to `sharp`/librsvg.            |
 | `footer`     | none                           | Footer text; omit the field for none.               |
 | `badge`      | none                           | Corner badge for `banner`; omit the field for none. |
-| `dimensions` | `1200×1200` and `1200×630`     | Any list of `{ width, height }`.                    |
-| `templates`  | `banner`, `card`               | Merged over the built-ins.                          |
+| `code`       | `github-dark`, monospace stack | Styling for the `code` template (see above).        |
+| `sizes`      | `og` + `square`                | Named output sizes (see below).                     |
+| `templates`  | `banner`, `card`, `code`       | Merged over the built-ins.                          |
+
+### Output sizes and filenames
+
+Each output size is a named `{ name, width, height }`. The `name` becomes the
+filename suffix, so every image is distinct: `my-post-og.png`,
+`my-post-square.png`. The default set is one 1.91:1 Open Graph landscape and one
+1:1 square, which between them satisfy `og:image` and both `twitter:image` card
+types (`summary_large_image` reuses the landscape; `summary` uses the square).
+
+`SIZE_PRESETS` ships the common standards — compose your own set:
+
+```ts
+import { defineConfig, SIZE_PRESETS } from "@kensio/colophon";
+
+export default defineConfig({
+  sizes: [
+    SIZE_PRESETS.og, // 1200×630 — og:image (Facebook, LinkedIn, Slack, …)
+    SIZE_PRESETS.square, // 1200×1200 — Twitter summary card, universal
+    SIZE_PRESETS.twitter, // 1200×600 (2:1) — Twitter summary_large_image
+    SIZE_PRESETS.pinterest, // 1000×1500 (2:3) — Pinterest
+    { name: "hero", width: 1600, height: 900 }, // or anything custom
+  ],
+});
+```
+
+The base filename is the **post slug**: Colophon reads a top-level `slug` from
+frontmatter (SEO-friendly, keyword-rich), falling back to the file name — or the
+parent directory for `index.*` files. Point `slugField` at a different key, or
+override naming entirely with `generate`'s `outputPath` callback.
 
 ### Frontmatter shape
 
 By default Colophon reads a `meta_img_props` object and a `template` field
-within it. Both are configurable via walk options (`propsKey`, `templateField`,
-`defaultTemplate`, `extensions`) so you can match an existing convention.
+within it, plus a top-level `slug`. All are configurable via walk options
+(`propsKey`, `templateField`, `defaultTemplate`, `slugField`, `extensions`) so
+you can match an existing convention.
 
 ## Sample output
 
@@ -182,8 +281,30 @@ updated PNGs so this gallery stays in sync.
       <sub><code>card</code> · 1200×630 · solid background, title only</sub>
     </td>
   </tr>
+  <tr>
+    <td>
+      <img src="docs/samples/code-square.png" alt="code template, square" width="100%" /><br />
+      <sub><code>code</code> · 1200×1200 · bash, <code>github-dark</code></sub>
+    </td>
+    <td>
+      <img src="docs/samples/code-wide.png" alt="code template, landscape" width="100%" /><br />
+      <sub><code>code</code> · 1200×630 · TypeScript, <code>night-owl</code></sub>
+    </td>
+  </tr>
 </table>
 
+## Upgrading from 1.x
+
+Adding the `code` template made two small breaking changes:
+
+- `Template.render` may now return `string | Promise<string>`, and `buildSvg`
+  is `async`. Custom templates that return a string still work unchanged; call
+  sites of `buildSvg` need an `await`. `renderMetaImages` and `generate` were
+  already async and are unaffected.
+- `MetaImageProps.title` is optional, and `walkContent`/`extractProps` no
+  longer skip a file that declares props without a title — a `code` post
+  describes its image entirely through `code` and `language`.
+
 ## Development
 
 - `pnpm build` — compile to `dist/`.

package/dist/config.d.ts

@@ -1,10 +1,57 @@
-import type { BrandColors, ColophonConfig, Dimensions, ResolvedConfig } from "./types.js";
-/** Default output sizes: a 1:1 square plus a 1.91:1 landscape (Open Graph). */
-export declare const DEFAULT_DIMENSIONS: readonly Dimensions[];
+import type { BrandColors, CodeStyle, ColophonConfig, OutputSize, ResolvedConfig } from "./types.js";
+/**
+ * Named output-size presets covering the common social-image standards. Each
+ * `name` becomes the filename suffix (e.g. `my-post-og.png`).
+ *
+ * - `og` — 1.91:1, the Open Graph standard (`og:image`): Facebook, LinkedIn,
+ *   Slack, Discord, WhatsApp, Mastodon, and the usual `twitter:image` reuse.
+ * - `square` — 1:1, X/Twitter `summary` card and a universal fallback.
+ * - `twitter` — 2:1, X/Twitter `summary_large_image` card.
+ * - `pinterest` — 2:3 tall pin.
+ */
+export declare const SIZE_PRESETS: {
+    readonly og: {
+        readonly name: "og";
+        readonly width: 1200;
+        readonly height: 630;
+    };
+    readonly square: {
+        readonly name: "square";
+        readonly width: 1200;
+        readonly height: 1200;
+    };
+    readonly twitter: {
+        readonly name: "twitter";
+        readonly width: 1200;
+        readonly height: 600;
+    };
+    readonly pinterest: {
+        readonly name: "pinterest";
+        readonly width: 1000;
+        readonly height: 1500;
+    };
+};
+/**
+ * Default output sizes: the Open Graph landscape plus a square. Between them
+ * they satisfy `og:image` and both `twitter:image` card types.
+ */
+export declare const DEFAULT_SIZES: readonly OutputSize[];
 /** Default font stack. Override via `config.fontFamily` for branded fonts. */
 export declare const DEFAULT_FONT_FAMILY = "Arial, Helvetica, sans-serif";
 /** Neutral default palette, used when no `colors.brand` is supplied. */
 export declare const DEFAULT_COLORS: Required<BrandColors>;
+/**
+ * Default monospace stack for the `code` template. It ends in the generic
+ * `monospace` family so it always resolves to something, whatever fonts the
+ * machine running the build happens to have.
+ */
+export declare const DEFAULT_CODE_FONT_FAMILY = "\"JetBrains Mono\", \"Source Code Pro\", \"DejaVu Sans Mono\", Menlo, Consolas, monospace";
+/**
+ * Default `code` template styling. `charWidthRatio` and `lineHeight` drive the
+ * monospace grid the snippet is laid out on; the font-size bounds are
+ * fractions of the image height so they hold at every output size.
+ */
+export declare const DEFAULT_CODE_STYLE: Required<CodeStyle>;
 /**
  * Identity helper that returns its argument typed as {@link ColophonConfig}.
  * Use it in a config module to get editor completion and type-checking.

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,WAAW,EACX,cAAc,EACd,UAAU,EACV,cAAc,EACf,MAAM,YAAY,CAAC;AAEpB,+EAA+E;AAC/E,eAAO,MAAM,kBAAkB,EAAE,SAAS,UAAU,EAGnD,CAAC;AAEF,8EAA8E;AAC9E,eAAO,MAAM,mBAAmB,iCAAiC,CAAC;AAElE,wEAAwE;AACxE,eAAO,MAAM,cAAc,EAAE,QAAQ,CAAC,WAAW,CAKhD,CAAC;AAEF;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,cAAc,CAEnE;AA4BD;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,GAAE,cAAmB,GAAG,cAAc,CAgBzE"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,WAAW,EACX,SAAS,EACT,cAAc,EACd,UAAU,EACV,cAAc,EACf,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY;;iBACjB,IAAI,EAAE,IAAI;iBAAE,KAAK,EAAE,IAAI;iBAAE,MAAM,EAAE,GAAG;;;iBAChC,IAAI,EAAE,QAAQ;iBAAE,KAAK,EAAE,IAAI;iBAAE,MAAM,EAAE,IAAI;;;iBACxC,IAAI,EAAE,SAAS;iBAAE,KAAK,EAAE,IAAI;iBAAE,MAAM,EAAE,GAAG;;;iBACvC,IAAI,EAAE,WAAW;iBAAE,KAAK,EAAE,IAAI;iBAAE,MAAM,EAAE,IAAI;;CACZ,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,SAAS,UAAU,EAG9C,CAAC;AAEF,8EAA8E;AAC9E,eAAO,MAAM,mBAAmB,iCAAiC,CAAC;AAElE,wEAAwE;AACxE,eAAO,MAAM,cAAc,EAAE,QAAQ,CAAC,WAAW,CAKhD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,8FACkD,CAAC;AAExF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,QAAQ,CAAC,SAAS,CASlD,CAAC;AAEF;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,cAAc,CAEnE;AAoDD;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,GAAE,cAAmB,GAAG,cAAc,CAazE"}

package/dist/config.js

@@ -1,8 +1,27 @@
 import { builtinTemplates } from "./templates/index.js";
-/** Default output sizes: a 1:1 square plus a 1.91:1 landscape (Open Graph). */
-export const DEFAULT_DIMENSIONS = [
-    { width: 1200, height: 1200 },
-    { width: 1200, height: 630 },
+/**
+ * Named output-size presets covering the common social-image standards. Each
+ * `name` becomes the filename suffix (e.g. `my-post-og.png`).
+ *
+ * - `og` — 1.91:1, the Open Graph standard (`og:image`): Facebook, LinkedIn,
+ *   Slack, Discord, WhatsApp, Mastodon, and the usual `twitter:image` reuse.
+ * - `square` — 1:1, X/Twitter `summary` card and a universal fallback.
+ * - `twitter` — 2:1, X/Twitter `summary_large_image` card.
+ * - `pinterest` — 2:3 tall pin.
+ */
+export const SIZE_PRESETS = {
+    og: { name: "og", width: 1200, height: 630 },
+    square: { name: "square", width: 1200, height: 1200 },
+    twitter: { name: "twitter", width: 1200, height: 600 },
+    pinterest: { name: "pinterest", width: 1000, height: 1500 },
+};
+/**
+ * Default output sizes: the Open Graph landscape plus a square. Between them
+ * they satisfy `og:image` and both `twitter:image` card types.
+ */
+export const DEFAULT_SIZES = [
+    SIZE_PRESETS.og,
+    SIZE_PRESETS.square,
 ];
 /** Default font stack. Override via `config.fontFamily` for branded fonts. */
 export const DEFAULT_FONT_FAMILY = "Arial, Helvetica, sans-serif";
@@ -13,6 +32,27 @@ export const DEFAULT_COLORS = {
     brandWarm: "#db2777",
     foreground: "#ffffff",
 };
+/**
+ * Default monospace stack for the `code` template. It ends in the generic
+ * `monospace` family so it always resolves to something, whatever fonts the
+ * machine running the build happens to have.
+ */
+export const DEFAULT_CODE_FONT_FAMILY = '"JetBrains Mono", "Source Code Pro", "DejaVu Sans Mono", Menlo, Consolas, monospace';
+/**
+ * Default `code` template styling. `charWidthRatio` and `lineHeight` drive the
+ * monospace grid the snippet is laid out on; the font-size bounds are
+ * fractions of the image height so they hold at every output size.
+ */
+export const DEFAULT_CODE_STYLE = {
+    theme: "github-dark",
+    fontFamily: DEFAULT_CODE_FONT_FAMILY,
+    charWidthRatio: 0.6,
+    lineHeight: 1.55,
+    tabSize: 2,
+    cornerScale: 0.025,
+    maxFontScale: 0.075,
+    minFontScale: 0.018,
+};
 /**
  * Identity helper that returns its argument typed as {@link ColophonConfig}.
  * Use it in a config module to get editor completion and type-checking.
@@ -43,21 +83,35 @@ function defaultBackground(colors) {
         ],
     };
 }
+function resolveCode(code) {
+    return { ...DEFAULT_CODE_STYLE, ...code };
+}
+function resolveSizes(sizes) {
+    if (sizes === undefined || sizes.length === 0) {
+        return DEFAULT_SIZES;
+    }
+    const seen = new Set();
+    for (const size of sizes) {
+        if (seen.has(size.name)) {
+            throw new Error(`Duplicate output size name "${size.name}"; names must be unique so each image gets a distinct filename.`);
+        }
+        seen.add(size.name);
+    }
+    return sizes;
+}
 /**
  * Apply defaults to a user config. Safe to call with no argument.
  */
 export function resolveConfig(config = {}) {
     const colors = resolveColors(config.colors);
-    const dimensions = config.dimensions && config.dimensions.length > 0
-        ? config.dimensions
-        : DEFAULT_DIMENSIONS;
     return {
         colors,
         background: config.background ?? defaultBackground(colors),
         fontFamily: config.fontFamily ?? DEFAULT_FONT_FAMILY,
         footer: config.footer,
         badge: config.badge,
-        dimensions,
+        code: resolveCode(config.code),
+        sizes: resolveSizes(config.sizes),
         templates: { ...builtinTemplates, ...config.templates },
     };
 }

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AASxD,+EAA+E;AAC/E,MAAM,CAAC,MAAM,kBAAkB,GAA0B;IACvD,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;IAC7B,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE;CAC7B,CAAC;AAEF,8EAA8E;AAC9E,MAAM,CAAC,MAAM,mBAAmB,GAAG,8BAA8B,CAAC;AAElE,wEAAwE;AACxE,MAAM,CAAC,MAAM,cAAc,GAA0B;IACnD,KAAK,EAAE,SAAS;IAChB,SAAS,EAAE,SAAS;IACpB,SAAS,EAAE,SAAS;IACpB,UAAU,EAAE,SAAS;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,MAAsB;IACjD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CAAC,MAA+B;IACpD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,6EAA6E;IAC7E,0DAA0D;IAC1D,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,KAAK;QAC3C,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,KAAK;QAC3C,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,cAAc,CAAC,UAAU;KAC3D,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,MAA6B;IACtD,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE;YACL,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE;YACzC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE;YACtC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE;SAC5C;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,MAAM,GAAmB,EAAE;IACvD,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5C,MAAM,UAAU,GACd,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;QAC/C,CAAC,CAAC,MAAM,CAAC,UAAU;QACnB,CAAC,CAAC,kBAAkB,CAAC;IAEzB,OAAO;QACL,MAAM;QACN,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,iBAAiB,CAAC,MAAM,CAAC;QAC1D,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,mBAAmB;QACpD,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,UAAU;QACV,SAAS,EAAE,EAAE,GAAG,gBAAgB,EAAE,GAAG,MAAM,CAAC,SAAS,EAAE;KACxD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAUxD;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE;IAC5C,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;IACrD,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE;IACtD,SAAS,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;CACd,CAAC;AAEhD;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAA0B;IAClD,YAAY,CAAC,EAAE;IACf,YAAY,CAAC,MAAM;CACpB,CAAC;AAEF,8EAA8E;AAC9E,MAAM,CAAC,MAAM,mBAAmB,GAAG,8BAA8B,CAAC;AAElE,wEAAwE;AACxE,MAAM,CAAC,MAAM,cAAc,GAA0B;IACnD,KAAK,EAAE,SAAS;IAChB,SAAS,EAAE,SAAS;IACpB,SAAS,EAAE,SAAS;IACpB,UAAU,EAAE,SAAS;CACtB,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GACnC,qFAAqF,CAAC;AAExF;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAwB;IACrD,KAAK,EAAE,aAAa;IACpB,UAAU,EAAE,wBAAwB;IACpC,cAAc,EAAE,GAAG;IACnB,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,CAAC;IACV,WAAW,EAAE,KAAK;IAClB,YAAY,EAAE,KAAK;IACnB,YAAY,EAAE,KAAK;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,MAAsB;IACjD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CAAC,MAA+B;IACpD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,6EAA6E;IAC7E,0DAA0D;IAC1D,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,KAAK;QAC3C,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,KAAK;QAC3C,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,cAAc,CAAC,UAAU;KAC3D,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,MAA6B;IACtD,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE;YACL,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE;YACzC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE;YACtC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE;SAC5C;KACF,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,IAA2B;IAC9C,OAAO,EAAE,GAAG,kBAAkB,EAAE,GAAG,IAAI,EAAE,CAAC;AAC5C,CAAC;AAED,SAAS,YAAY,CACnB,KAAwC;IAExC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9C,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,+BAA+B,IAAI,CAAC,IAAI,iEAAiE,CAC1G,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,MAAM,GAAmB,EAAE;IACvD,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE5C,OAAO;QACL,MAAM;QACN,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,iBAAiB,CAAC,MAAM,CAAC;QAC1D,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,mBAAmB;QACpD,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC;QAC9B,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC;QACjC,SAAS,EAAE,EAAE,GAAG,gBAAgB,EAAE,GAAG,MAAM,CAAC,SAAS,EAAE;KACxD,CAAC;AACJ,CAAC"}

package/dist/content/index.d.ts

@@ -11,6 +11,11 @@ export interface WalkOptions {
     readonly templateField?: string;
     /** Template to use when the template field is absent. */
     readonly defaultTemplate?: string;
+    /**
+     * Top-level frontmatter field to read the post slug from (used as the base
+     * filename). Default `slug`; falls back to the file/directory name.
+     */
+    readonly slugField?: string;
     /** File extensions to include. Default `.md` and `.markdown`. */
     readonly extensions?: readonly string[];
 }
@@ -22,8 +27,16 @@ export interface ContentFile {
     readonly contentPath: string;
     /** Absolute path on disk. */
     readonly absolutePath: string;
+    /** Base filename for this post's images (frontmatter slug, or path-derived). */
+    readonly slug: string;
     readonly props: MetaImageProps;
 }
+/**
+ * Derive a slug from a file path: the filename without extension, or the
+ * parent directory name when the file is `index.*` (the common page-bundle
+ * convention).
+ */
+export declare function slugFromPath(filePath: string): string;
 /**
  * Extract {@link MetaImageProps} from a parsed frontmatter object, or return
  * `undefined` if this file should be skipped (no props object, or no usable

package/dist/content/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/content/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAsBlD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,8DAA8D;IAC9D,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,gFAAgF;IAChF,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,6EAA6E;IAC7E,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,yDAAyD;IACzD,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,iEAAiE;IACjE,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,uCAAuC;IACvC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,6BAA6B;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;CAChC;AAMD;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,OAAO,GAAE,IAAI,CACX,WAAW,EACX,UAAU,GAAG,eAAe,GAAG,iBAAiB,CAC5C,GACL,cAAc,GAAG,SAAS,CA+C5B;AA8BD;;;;GAIG;AACH,wBAAsB,WAAW,CAC/B,OAAO,EAAE,WAAW,GACnB,OAAO,CAAC,WAAW,EAAE,CAAC,CAsBxB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/content/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAuBlD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,8DAA8D;IAC9D,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,gFAAgF;IAChF,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,6EAA6E;IAC7E,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,yDAAyD;IACzD,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,iEAAiE;IACjE,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,uCAAuC;IACvC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,6BAA6B;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,gFAAgF;IAChF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;CAChC;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAIrD;AAMD;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,OAAO,GAAE,IAAI,CACX,WAAW,EACX,UAAU,GAAG,eAAe,GAAG,iBAAiB,CAC5C,GACL,cAAc,GAAG,SAAS,CA4C5B;AA8BD;;;;GAIG;AACH,wBAAsB,WAAW,CAC/B,OAAO,EAAE,WAAW,GACnB,OAAO,CAAC,WAAW,EAAE,CAAC,CAgCxB"}

package/dist/content/index.js

@@ -3,6 +3,7 @@ import path from "node:path";
 import matter from "gray-matter";
 const defaultPropsKey = "meta_img_props";
 const defaultTemplateField = "template";
+const defaultSlugField = "slug";
 const defaultExtensions = [".md", ".markdown"];
 function coerceString(value) {
     if (typeof value === "string") {
@@ -15,6 +16,16 @@ function coerceString(value) {
     }
     return undefined;
 }
+/**
+ * Derive a slug from a file path: the filename without extension, or the
+ * parent directory name when the file is `index.*` (the common page-bundle
+ * convention).
+ */
+export function slugFromPath(filePath) {
+    const extension = path.extname(filePath);
+    const base = path.basename(filePath, extension);
+    return base === "index" ? path.basename(path.dirname(filePath)) : base;
+}
 function isRecord(value) {
     return typeof value === "object" && value !== null && !Array.isArray(value);
 }
@@ -35,10 +46,9 @@ export function extractProps(frontmatter, options = {}) {
     if (template === undefined) {
         return undefined;
     }
-    const titleRaw = record["title"];
-    if (typeof titleRaw !== "string") {
-        return undefined;
-    }
+    // Title is optional: templates such as `code` describe the image entirely
+    // from their own fields, and requiring a title would be pure boilerplate.
+    const title = coerceString(record["title"]);
     const subtitle = coerceString(record["subtitle"]);
     const version = coerceString(record["version"]);
     const extras = {};
@@ -54,7 +64,7 @@ export function extractProps(frontmatter, options = {}) {
     return {
         ...extras,
         template,
-        title: titleRaw,
+        ...(title !== undefined && { title }),
         ...(subtitle !== undefined && { subtitle }),
         ...(version !== undefined && { version }),
     };
@@ -82,15 +92,22 @@ async function collectContentFiles(dir, extensions) {
 export async function walkContent(options) {
     const extensions = options.extensions ?? defaultExtensions;
     const filePaths = await collectContentFiles(options.dir, extensions);
+    const slugField = options.slugField ?? defaultSlugField;
     const files = await Promise.all(filePaths.map(async (filePath) => {
         const raw = await readFile(filePath, "utf8");
-        const props = extractProps(matter(raw).data, options);
+        const frontmatter = matter(raw).data;
+        const props = extractProps(frontmatter, options);
         if (props === undefined) {
             return;
         }
+        const declaredSlug = coerceString(frontmatter[slugField])?.trim();
+        const slug = declaredSlug !== undefined && declaredSlug !== ""
+            ? declaredSlug
+            : slugFromPath(filePath);
         return {
             contentPath: path.relative(options.dir, filePath),
             absolutePath: filePath,
+            slug,
             props,
         };
     }));

package/dist/content/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/content/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,MAAM,MAAM,aAAa,CAAC;AAIjC,MAAM,eAAe,GAAG,gBAAgB,CAAC;AACzC,MAAM,oBAAoB,GAAG,UAAU,CAAC;AACxC,MAAM,iBAAiB,GAAsB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;AAElE,SAAS,YAAY,CAAC,KAAc;IAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,SAAS;QAC1B,OAAO,KAAK,KAAK,QAAQ,EACzB,CAAC;QACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AA6BD,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAC1B,WAAoC,EACpC,OAAO,GAGH,EAAE;IAEN,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAC;IACrD,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,oBAAoB,CAAC;IAEpE,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IAErC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;IAC1C,MAAM,QAAQ,GACZ,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;IAE1E,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAEjC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAClD,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,IACE,GAAG,KAAK,aAAa;YACrB,GAAG,KAAK,UAAU;YAClB,GAAG,KAAK,OAAO;YACf,GAAG,KAAK,UAAU;YAClB,GAAG,KAAK,SAAS,EACjB,CAAC;YACD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACtB,CAAC;IACH,CAAC;IAED,OAAO;QACL,GAAG,MAAM;QACT,QAAQ;QACR,KAAK,EAAE,QAAQ;QACf,GAAG,CAAC,QAAQ,KAAK,SAAS,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC3C,GAAG,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,CAAC;KAC1C,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,mBAAmB,CAChC,GAAW,EACX,UAA6B;IAE7B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5D,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAE7C,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,OAAO,mBAAmB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACpD,CAAC;QAED,IACE,KAAK,CAAC,MAAM,EAAE;YACd,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAC9D,CAAC;YACD,OAAO,CAAC,SAAS,CAAC,CAAC;QACrB,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;AACvB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,OAAoB;IAEpB,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;IAC3D,MAAM,SAAS,GAAG,MAAM,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IAErE,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAC7B,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QAC/B,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC7C,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEtD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QAED,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC;YACjD,YAAY,EAAE,QAAQ;YACtB,KAAK;SACN,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAuB,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;AACzE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/content/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,MAAM,MAAM,aAAa,CAAC;AAIjC,MAAM,eAAe,GAAG,gBAAgB,CAAC;AACzC,MAAM,oBAAoB,GAAG,UAAU,CAAC;AACxC,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAChC,MAAM,iBAAiB,GAAsB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;AAElE,SAAS,YAAY,CAAC,KAAc;IAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,SAAS;QAC1B,OAAO,KAAK,KAAK,QAAQ,EACzB,CAAC;QACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAoCD;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,QAAgB;IAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAChD,OAAO,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACzE,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAC1B,WAAoC,EACpC,OAAO,GAGH,EAAE;IAEN,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAC;IACrD,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,oBAAoB,CAAC;IAEpE,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IAErC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;IAC1C,MAAM,QAAQ,GACZ,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;IAE1E,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,0EAA0E;IAC1E,0EAA0E;IAC1E,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAClD,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,IACE,GAAG,KAAK,aAAa;YACrB,GAAG,KAAK,UAAU;YAClB,GAAG,KAAK,OAAO;YACf,GAAG,KAAK,UAAU;YAClB,GAAG,KAAK,SAAS,EACjB,CAAC;YACD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACtB,CAAC;IACH,CAAC;IAED,OAAO;QACL,GAAG,MAAM;QACT,QAAQ;QACR,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,EAAE,KAAK,EAAE,CAAC;QACrC,GAAG,CAAC,QAAQ,KAAK,SAAS,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC3C,GAAG,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,CAAC;KAC1C,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,mBAAmB,CAChC,GAAW,EACX,UAA6B;IAE7B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5D,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAE7C,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,OAAO,mBAAmB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACpD,CAAC;QAED,IACE,KAAK,CAAC,MAAM,EAAE;YACd,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAC9D,CAAC;YACD,OAAO,CAAC,SAAS,CAAC,CAAC;QACrB,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;AACvB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,OAAoB;IAEpB,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;IAC3D,MAAM,SAAS,GAAG,MAAM,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IAErE,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,gBAAgB,CAAC;IAExD,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAC7B,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QAC/B,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC7C,MAAM,WAAW,GAA4B,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;QAC9D,MAAM,KAAK,GAAG,YAAY,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAEjD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QAED,MAAM,YAAY,GAAG,YAAY,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;QAClE,MAAM,IAAI,GACR,YAAY,KAAK,SAAS,IAAI,YAAY,KAAK,EAAE;YAC/C,CAAC,CAAC,YAAY;YACd,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAE7B,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC;YACjD,YAAY,EAAE,QAAQ;YACtB,IAAI;YACJ,KAAK;SACN,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAuB,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;AACzE,CAAC"}

package/dist/generate.d.ts

@@ -1,11 +1,11 @@
 import type { ContentFile, WalkOptions } from "./content/index.js";
-import type { ColophonConfig, Dimensions } from "./types.js";
+import type { ColophonConfig, OutputSize } from "./types.js";
 /**
  * Outcome for one generated (or skipped) image.
  */
 export interface GeneratedImage {
     readonly contentPath: string;
-    readonly dimensions: Dimensions;
+    readonly size: OutputSize;
     readonly outputPath: string;
     /** True when an existing file was left in place (no `overwrite`). */
     readonly skipped: boolean;
@@ -17,21 +17,21 @@ export interface GenerateOptions {
     /** Root content directory to walk. */
     readonly contentDir: string;
     readonly config?: ColophonConfig;
-    /** Extra walk options (props key, template field, extensions, …). */
+    /** Extra walk options (props key, template field, slug field, extensions). */
     readonly walk?: Omit<WalkOptions, "dir">;
     /** Override where each image is written. */
-    readonly outputPath?: (file: ContentFile, dimensions: Dimensions, index: number) => string;
+    readonly outputPath?: (file: ContentFile, size: OutputSize) => string;
     /** Re-render even when the output file already exists. Default `false`. */
     readonly overwrite?: boolean;
     /** Called after each image is written or skipped. */
     readonly onResult?: (result: GeneratedImage) => void;
 }
 /**
- * Default output path: alongside the content file, named after the file (or
- * its parent directory when the file is `index.*`). The first (square) size
- * keeps the bare name; additional sizes get a `-WxH` suffix.
+ * Default output path: alongside the content file, named `<slug>-<size>.png`.
+ * The slug carries the post's keywords into the filename and the size name
+ * keeps every image distinct (e.g. `my-post-og.png`, `my-post-square.png`).
  */
-export declare function defaultOutputPath(file: ContentFile, dimensions: Dimensions, index: number): string;
+export declare function defaultOutputPath(file: ContentFile, size: OutputSize): string;
 /**
  * Walk a content tree and render meta images for every file that declares
  * props, writing PNGs to disk. Existing files are skipped unless `overwrite`

package/dist/generate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGnE,OAAO,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,qEAAqE;IACrE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,sCAAsC;IACtC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC;IACjC,qEAAqE;IACrE,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACzC,4CAA4C;IAC5C,QAAQ,CAAC,UAAU,CAAC,EAAE,CACpB,IAAI,EAAE,WAAW,EACjB,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,MAAM,KACV,MAAM,CAAC;IACZ,2EAA2E;IAC3E,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,qDAAqD;IACrD,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,IAAI,CAAC;CACtD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,WAAW,EACjB,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,MAAM,GACZ,MAAM,CAWR;AAED;;;;;GAKG;AACH,wBAAsB,QAAQ,CAC5B,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,cAAc,EAAE,CAAC,CAmC3B"}
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGnE,OAAO,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,qEAAqE;IACrE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,sCAAsC;IACtC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC;IACjC,8EAA8E;IAC9E,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACzC,4CAA4C;IAC5C,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,KAAK,MAAM,CAAC;IACtE,2EAA2E;IAC3E,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,qDAAqD;IACrD,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,IAAI,CAAC;CACtD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,GAAG,MAAM,CAG7E;AAED;;;;;GAKG;AACH,wBAAsB,QAAQ,CAC5B,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,cAAc,EAAE,CAAC,CAgC3B"}

package/dist/generate.js

@@ -5,19 +5,13 @@ import { resolveConfig } from "./config.js";
 import { walkContent } from "./content/index.js";
 import { buildSvg, renderSvgToPng } from "./render.js";
 /**
- * Default output path: alongside the content file, named after the file (or
- * its parent directory when the file is `index.*`). The first (square) size
- * keeps the bare name; additional sizes get a `-WxH` suffix.
+ * Default output path: alongside the content file, named `<slug>-<size>.png`.
+ * The slug carries the post's keywords into the filename and the size name
+ * keeps every image distinct (e.g. `my-post-og.png`, `my-post-square.png`).
  */
-export function defaultOutputPath(file, dimensions, index) {
+export function defaultOutputPath(file, size) {
     const directory = path.dirname(file.absolutePath);
-    const extension = path.extname(file.contentPath);
-    const base = path.basename(file.contentPath, extension);
-    const stem = base === "index" ? path.basename(directory) : base;
-    const suffix = index === 0
-        ? ""
-        : `-${String(dimensions.width)}x${String(dimensions.height)}`;
-    return path.join(directory, `${stem}${suffix}.png`);
+    return path.join(directory, `${file.slug}-${size.name}.png`);
 }
 /**
  * Walk a content tree and render meta images for every file that declares
@@ -29,23 +23,20 @@ export async function generate(options) {
     const resolved = resolveConfig(options.config);
     const toOutputPath = options.outputPath ?? defaultOutputPath;
     const files = await walkContent({ dir: options.contentDir, ...options.walk });
-    const jobs = files.flatMap((file) => resolved.dimensions.map((dimensions, index) => ({
-        file,
-        dimensions,
-        index,
-    })));
-    return Promise.all(jobs.map(async ({ file, dimensions, index }) => {
-        const outputPath = toOutputPath(file, dimensions, index);
+    const jobs = files.flatMap((file) => resolved.sizes.map((size) => ({ file, size })));
+    return Promise.all(jobs.map(async ({ file, size }) => {
+        const outputPath = toOutputPath(file, size);
         const isSkipped = existsSync(outputPath) && options.overwrite !== true;
         if (!isSkipped) {
-            const svg = buildSvg(file.props, resolved, dimensions);
+            const dimensions = { width: size.width, height: size.height };
+            const svg = await buildSvg(file.props, resolved, dimensions);
             const png = await renderSvgToPng(svg, dimensions);
             await mkdir(path.dirname(outputPath), { recursive: true });
             await writeFile(outputPath, png);
         }
         const result = {
             contentPath: file.contentPath,
-            dimensions,
+            size,
             outputPath,
             skipped: isSkipped,
         };

package/dist/generate.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate.js","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAmCvD;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,IAAiB,EACjB,UAAsB,EACtB,KAAa;IAEb,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IACxD,MAAM,IAAI,GAAG,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAChE,MAAM,MAAM,GACV,KAAK,KAAK,CAAC;QACT,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;IAElE,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,GAAG,MAAM,MAAM,CAAC,CAAC;AACtD,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,OAAwB;IAExB,MAAM,QAAQ,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;IAC7D,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAE9E,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAClC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC9C,IAAI;QACJ,UAAU;QACV,KAAK;KACN,CAAC,CAAC,CACJ,CAAC;IAEF,OAAO,OAAO,CAAC,GAAG,CAChB,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE;QAC7C,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QACzD,MAAM,SAAS,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC;QAEvE,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;YACvD,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;YAClD,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3D,MAAM,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACnC,CAAC;QAED,MAAM,MAAM,GAAmB;YAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,UAAU;YACV,UAAU;YACV,OAAO,EAAE,SAAS;SACnB,CAAC;QACF,OAAO,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CACH,CAAC;AACJ,CAAC"}
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AA+BvD;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAiB,EAAE,IAAgB;IACnE,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClD,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,MAAM,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,OAAwB;IAExB,MAAM,QAAQ,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;IAC7D,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAE9E,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAClC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAC/C,CAAC;IAEF,OAAO,OAAO,CAAC,GAAG,CAChB,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE;QAChC,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5C,MAAM,SAAS,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC;QAEvE,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,UAAU,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;YAC9D,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;YAC7D,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;YAClD,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3D,MAAM,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACnC,CAAC;QAED,MAAM,MAAM,GAAmB;YAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,IAAI;YACJ,UAAU;YACV,OAAO,EAAE,SAAS;SACnB,CAAC;QACF,OAAO,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CACH,CAAC;AACJ,CAAC"}