@timmo001/docs-kit 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,135 @@
-# Temporary Holding Version
+# @timmo001/docs-kit
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Shared branding, layout and config for my documentation sites.
+
+The root export renders brand images and doesn't depend on a docs tool. The
+`blume` export holds the [Blume](https://github.com/haydenbleasel/blume) parts: a config helper, a
+home page banner, a header GitHub link and a layout stylesheet. If the sites
+move off Blume, the root export stays and a new tool gets its own entry point.
+
+## Install
+
+```sh
+bun add -E @timmo001/docs-kit
+```
+
+The `blume` export needs the `blume` version in `peerDependencies`.
+
+## Blume
+
+### Config
+
+`docsConfig` returns a full Blume config from the site details. Pass anything
+else Blume accepts alongside them; it overrides the default it replaces, and
+`navigation` and `seo` merge one level deep.
+
+```ts
+import { docsConfig } from "@timmo001/docs-kit/blume";
+import { defineConfig } from "blume";
+
+export default defineConfig(
+  docsConfig({
+    title: "Triage",
+    description: "Pull request triage from the terminal.",
+    site: "triage.timmo.dev",
+    github: { owner: "timmo001", repo: "triage" },
+    navigation: {
+      sidebar: ["/", "/getting-started"],
+    },
+  }),
+);
+```
+
+The defaults:
+
+- Light and dark logos from `public/logo-light.svg` and `public/logo-dark.svg`,
+  with the title as the logo text.
+- Content in `src/content/docs`, last-modified dates from git and external links
+  opening in a new tab.
+- Cloudflare deployment to `https://<site>`.
+- `llms.txt`, the MCP endpoint at `/mcp`, WebMCP and agent readability on. Ask
+  AI and page feedback off.
+- GitHub `branch` set to `main` and `dir` to `docs`, plus the header repository
+  link.
+- Generated share cards using `src/assets/logo.svg`, and an organisation logo at
+  `/logo.png` (see [Brand images](#brand-images)).
+
+### Components
+
+Blume reads `components.ts` without running it, so import the components there
+directly:
+
+```ts
+import HeaderSearch from "@timmo001/docs-kit/blume/header-search.astro";
+import HomeBanner from "@timmo001/docs-kit/blume/home-banner.astro";
+import { defineComponents } from "blume";
+
+export default defineComponents({
+  layout: {
+    PageHeader: HomeBanner,
+    Search: HeaderSearch,
+  },
+});
+```
+
+- `HomeBanner` shows the logo, title and description across the top of the home
+  page and hides the page's own heading and lede. Other pages render nothing.
+- `HeaderSearch` keeps Blume's search and adds a GitHub link after it when the
+  config has a repository.
+
+Both use scoped CSS, so they don't rely on Tailwind scanning `node_modules`.
+
+### Theme
+
+Import the layout styles from the site's `theme.css`:
+
+```css
+@import "@timmo001/docs-kit/blume/theme.css";
+```
+
+This widens the content column on large screens and keeps the "On this page"
+rail next to the content. The banner's full-width layout relies on these
+columns.
+
+Set these in `theme.css` to change the banner:
+
+```css
+.home-banner {
+  --home-banner-logo-size: 20rem;
+  --home-banner-height: 30rem;
+  --home-banner-background: #e4e4e7;
+  --home-banner-background-dark: #09090b;
+}
+```
+
+## Brand images
+
+`writeBrandImages` renders PNGs from a square SVG logo with a `viewBox`: Open
+Graph and GitHub social preview cards, a 512px logo and an Apple touch icon.
+Leave an output out to skip it.
+
+```ts
+import { writeBrandImages } from "@timmo001/docs-kit";
+
+await writeBrandImages({
+  logo: "src/assets/logo.svg",
+  title: "Triage",
+  tagline: ["Pull request triage", "from the terminal."],
+  site: "triage.timmo.dev",
+  background: "#18181b",
+  accent: "#d97706",
+  outputs: {
+    socialPreview: "../.github/social-preview.png",
+    logo: "public/logo.png",
+    appleTouchIcon: "public/apple-touch-icon.png",
+  },
+});
+```
+
+Blume makes its own per-page share cards, so a Blume site only needs `og` for
+links outside the docs. GitHub doesn't read the social preview from the
+repository; upload it under the repository settings.
+
+## Development
+
+See the [repository README](https://github.com/timmo001/docs-kit#development).

package/package.json

@@ -1,6 +1,55 @@
 {
   "name": "@timmo001/docs-kit",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Shared branding, layout and config for timmo001 documentation sites",
+  "license": "Apache-2.0",
+  "type": "module",
+  "exports": {
+    ".": "./src/index.ts",
+    "./blume": "./src/blume/index.ts",
+    "./blume/header-search.astro": "./src/blume/header-search.astro",
+    "./blume/home-banner.astro": "./src/blume/home-banner.astro",
+    "./blume/theme.css": "./src/blume/theme.css",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": [
+    "*.css"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/timmo001/docs-kit.git",
+    "directory": "packages/docs-kit"
+  },
+  "scripts": {
+    "check": "bun run lint && bun run typecheck && bun run format:check",
+    "lint": "oxlint .",
+    "typecheck": "tsc",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
+  },
+  "dependencies": {
+    "sharp": "0.35.5"
+  },
+  "peerDependencies": {
+    "blume": "2.1.3"
+  },
+  "devDependencies": {
+    "@oxlint/plugins": "1.87.0",
+    "@timmo001/oxlint-rules": "0.5.0",
+    "@types/bun": "1.4.2",
+    "blume": "2.1.3",
+    "oxlint": "1.87.0",
+    "oxlint-tsgolint": "7.0.2003",
+    "prettier": "3.9.9",
+    "typescript": "7.0.2"
+  }
+}

package/src/blume/config.ts

@@ -0,0 +1,92 @@
+import type { BlumeConfig } from "blume";
+import { cloudflare } from "blume/deploy";
+
+/** Options for {@link docsConfig}: a Blume config plus the shared site details. */
+export interface DocsConfigOptions extends Omit<
+  BlumeConfig,
+  "github" | "title"
+> {
+  /** Site title, also used for the header logo text and alt text. */
+  title: string;
+  /** Host name the site deploys to, such as `docs.example.dev`. */
+  site: string;
+  /** Repository the docs live in. `branch` defaults to `main` and `dir` to `docs`. */
+  github: NonNullable<BlumeConfig["github"]>;
+}
+
+/**
+ * Build a Blume config with the shared defaults: light and dark logos from
+ * `public/`, Cloudflare deployment, agent surfaces on, Ask AI and feedback off,
+ * and generated share cards. Any option given here wins over the default it
+ * replaces; `navigation` and `seo` merge one level deep.
+ */
+export const docsConfig = ({
+  site,
+  github,
+  navigation,
+  seo,
+  ...config
+}: DocsConfigOptions): BlumeConfig => ({
+  logo: {
+    image: {
+      alt: config.title,
+      dark: "/logo-dark.svg",
+      light: "/logo-light.svg",
+    },
+    text: config.title,
+  },
+  content: {
+    root: "src/content/docs",
+  },
+  markdown: {
+    externalLinks: true,
+  },
+  ai: {
+    assistant: {
+      enabled: false,
+    },
+  },
+  agents: {
+    agentReadability: true,
+    contentSignals: {
+      aiInput: true,
+      aiTrain: false,
+      search: true,
+    },
+    llmsTxt: true,
+    mcp: {
+      enabled: true,
+      route: "/mcp",
+    },
+    webmcp: true,
+  },
+  deployment: cloudflare({
+    site: `https://${site}`,
+  }),
+  feedback: false,
+  lastModified: "git",
+  ...config,
+  github: {
+    branch: "main",
+    dir: "docs",
+    ...github,
+  },
+  navigation: {
+    repo: true,
+    ...navigation,
+  },
+  seo: {
+    ...seo,
+    og: {
+      enabled: true,
+      logo: "src/assets/logo.svg",
+      site,
+      ...seo?.og,
+    },
+    organization: {
+      logo: "/logo.png",
+      sameAs: [`https://github.com/${github.owner}/${github.repo}`],
+      ...seo?.organization,
+    },
+  },
+});

package/src/blume/header-search.astro

@@ -0,0 +1,47 @@
+---
+import Search from "blume/components/layout/Search.astro";
+import { SOCIAL_ICONS } from "blume/components/layout/footer-socials.ts";
+import data from "blume:data";
+
+const repoUrl = data.config.repoUrl;
+
+const github = SOCIAL_ICONS.github;
+---
+
+<Search {...Astro.props} />
+{
+  repoUrl && (
+    <a
+      aria-label="GitHub repository"
+      class="header-github"
+      data-blume-tooltip="GitHub repository"
+      href={repoUrl}
+      rel="noreferrer"
+      target="_blank"
+    >
+      <svg aria-hidden="true" fill="currentColor" height="18" viewBox="0 0 24 24" width="18">
+        <path d={github.path} />
+      </svg>
+    </a>
+  )
+}
+
+<style>
+  .header-github {
+    display: inline-flex;
+    flex-shrink: 0;
+    align-items: center;
+    justify-content: center;
+    width: 2.25rem;
+    height: 2.25rem;
+    border-radius: 9999px;
+    color: var(--color-muted-foreground);
+    transition-property: color, background-color;
+    transition-duration: 150ms;
+  }
+
+  .header-github:hover {
+    background-color: var(--color-muted);
+    color: var(--color-foreground);
+  }
+</style>

package/src/blume/home-banner.astro

@@ -0,0 +1,155 @@
+---
+import data from "blume:data";
+
+interface Props {
+  headings: { depth: number; slug: string; text: string }[];
+  page: { description?: string; route: string; title: string };
+  route: string;
+}
+
+const { page, route } = Astro.props;
+
+const home = route === "/" || page.route === "/";
+
+const description = page.description ?? data.config.description;
+---
+
+{
+  home && description && (
+    <section aria-labelledby="home-banner-title" class="home-banner">
+      <div class="home-banner-inner">
+        <img alt="" class="home-banner-logo home-banner-logo-light" height="208" src="/logo-light.svg" width="208" />
+        <img alt="" class="home-banner-logo home-banner-logo-dark" height="208" src="/logo-dark.svg" width="208" />
+        <h1 class="home-banner-title" id="home-banner-title">
+          {data.config.title}
+        </h1>
+        <p class="home-banner-description">{description}</p>
+      </div>
+    </section>
+  )
+}
+
+<style>
+  /* Set --home-banner-logo-size, --home-banner-height,
+     --home-banner-background or --home-banner-background-dark in the site's
+     theme.css to resize or recolour the banner. */
+  .home-banner {
+    position: relative;
+    overflow: hidden;
+    margin: -1.5rem -1.5rem 2rem;
+    padding: 0 1.5rem 1.5rem;
+    background-color: var(--home-banner-background, #d4d4d8);
+  }
+
+  :global([data-theme="dark"]) .home-banner {
+    background-color: var(--home-banner-background-dark, #18181b);
+  }
+
+  .home-banner-inner {
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    max-width: 48rem;
+    margin-inline: auto;
+    text-align: center;
+  }
+
+  .home-banner-logo {
+    width: var(--home-banner-logo-size, 9rem);
+    height: var(--home-banner-logo-size, 9rem);
+    margin-top: 1.5rem;
+  }
+
+  .home-banner-logo-dark,
+  :global([data-theme="dark"]) .home-banner-logo-light {
+    display: none;
+  }
+
+  :global([data-theme="dark"]) .home-banner-logo-dark {
+    display: block;
+  }
+
+  .home-banner-title {
+    margin-top: 0.5rem;
+    font-family: var(--font-display);
+    font-size: 2.25rem;
+    font-weight: 600;
+    line-height: 2.5rem;
+    letter-spacing: -0.025em;
+    color: #18181b;
+  }
+
+  :global([data-theme="dark"]) .home-banner-title {
+    color: #ffffff;
+  }
+
+  .home-banner-description {
+    max-width: 36rem;
+    margin-top: 0.75rem;
+    font-size: 1.125rem;
+    line-height: 1.75rem;
+    color: #3f3f46;
+  }
+
+  :global([data-theme="dark"]) .home-banner-description {
+    color: #d4d4d8;
+  }
+
+  /* The home page's own title is the banner. The layout still prints the
+     page heading and lede under it. */
+  :global(main:has(.home-banner) > article > h1:first-of-type),
+  :global(main:has(.home-banner) > article > h1:first-of-type + p) {
+    display: none;
+  }
+
+  @media (min-width: 40rem) {
+    .home-banner {
+      padding-bottom: 2rem;
+    }
+
+    .home-banner-logo {
+      width: var(--home-banner-logo-size, 13rem);
+      height: var(--home-banner-logo-size, 13rem);
+    }
+
+    .home-banner-title {
+      font-size: 3.75rem;
+      line-height: 1;
+    }
+
+    .home-banner-description {
+      font-size: 1.25rem;
+    }
+  }
+
+  @media (min-width: 64rem) {
+    .home-banner {
+      margin-inline: -2rem;
+    }
+  }
+
+  @media (min-width: 80rem) {
+    .home-banner {
+      margin-inline: -2.5rem;
+    }
+  }
+
+  /* Where the "On this page" rail shows, run the banner across the whole grid
+     (see theme.css for its columns) and start the rail below the banner. */
+  @media (min-width: 80rem) {
+    :global([data-blume-doc-grid]:has(> [data-blume-toc])) .home-banner {
+      --gutter: max(0px, (100cqw - 40rem - var(--blume-content-width)) / 2);
+
+      display: flex;
+      flex-direction: column;
+      justify-content: center;
+      height: var(--home-banner-height, 25rem);
+      margin-inline-start: calc(-2.5rem - var(--gutter));
+      margin-inline-end: calc(-20rem - var(--gutter));
+    }
+
+    :global(div:has(> main .home-banner) > [data-blume-toc]) {
+      margin-top: var(--home-banner-height, 25rem);
+    }
+  }
+</style>

package/src/blume/index.ts

@@ -0,0 +1 @@
+export { docsConfig, type DocsConfigOptions } from "./config.ts";

package/src/blume/theme.css

@@ -0,0 +1,37 @@
+/* Widen the content column on larger screens. */
+@media (min-width: 96rem) {
+  :root {
+    --blume-content-width: 52rem;
+  }
+}
+
+@media (min-width: 120rem) {
+  :root {
+    --blume-content-width: 60rem;
+  }
+}
+
+/* Keep the "On this page" rail beside the content instead of at the far right
+   edge: centre the content and rail, with equal space either side. The content
+   column is the content width plus main's 2.5rem padding either side.
+   home-banner.astro works out its full-width bleed from these columns. */
+@media (min-width: 80rem) {
+  [data-blume-doc-grid]:has(> [data-blume-toc]) {
+    container-type: inline-size;
+    grid-template-columns:
+      17.5rem minmax(0, 1fr) minmax(0, calc(var(--blume-content-width) + 5rem))
+      17.5rem minmax(0, 1fr);
+  }
+
+  [data-blume-doc-grid]:has(> [data-blume-toc]) > #blume-nav-drawer {
+    grid-column: 1;
+  }
+
+  [data-blume-doc-grid]:has(> [data-blume-toc]) > #blume-content {
+    grid-column: 3;
+  }
+
+  [data-blume-doc-grid]:has(> [data-blume-toc]) > [data-blume-toc] {
+    grid-column: 4;
+  }
+}

package/src/brand-images.ts

@@ -0,0 +1,120 @@
+import { mkdir, readFile } from "node:fs/promises";
+import path from "node:path";
+import sharp from "sharp";
+
+/** Where to write each image. Leave one out to skip it. */
+export interface BrandImageOutputs {
+  /** 1280×640 card for the GitHub repository's social preview. */
+  socialPreview?: string;
+  /** 1200×630 Open Graph card. */
+  og?: string;
+  /** 512px transparent logo, for `seo.organization.logo` and search engines. */
+  logo?: string;
+  /** 180px logo on the card background, for iOS home screens. */
+  appleTouchIcon?: string;
+}
+
+/** Options for {@link writeBrandImages}. */
+export interface BrandImagesOptions {
+  /** Path to the square SVG logo. */
+  logo: string;
+  /** Card headline, usually the site title. */
+  title: string;
+  /** Card subtitle, one entry per line. */
+  tagline: readonly string[];
+  /** Site address shown under the tagline. */
+  site: string;
+  /** Card and icon background colour. */
+  background: string;
+  /** Colour of the top strip and the site address. */
+  accent: string;
+  outputs: BrandImageOutputs;
+}
+
+const fontStack = "Inter, 'Liberation Sans', 'DejaVu Sans', Arial, sans-serif";
+
+const svgOpenTag = /^<svg\b[^>]*>/;
+
+const escapeXml = (text: string) =>
+  text.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;");
+
+/**
+ * Render the raster branding from a site's SVG logo: share cards with the
+ * logo, title, tagline and site address, and square PNG logos. Returns the
+ * paths written.
+ */
+export const writeBrandImages = async (
+  options: BrandImagesOptions,
+): Promise<string[]> => {
+  const logo = (await readFile(options.logo, "utf8")).trim();
+  const openTag = svgOpenTag.exec(logo)?.[0];
+  const viewBox = openTag?.match(/\bviewBox="([^"]+)"/)?.[1];
+
+  if (openTag === undefined || viewBox === undefined) {
+    throw new Error(
+      `${options.logo} must start with an <svg> tag that has a viewBox`,
+    );
+  }
+
+  const logoAt = (x: number, y: number, size: number) =>
+    logo.replace(
+      openTag,
+      `<svg x="${x}" y="${y}" width="${size}" height="${size}" viewBox="${viewBox}">`,
+    );
+
+  const card = (width: number, height: number) => {
+    const logoSize = 300;
+    const logoX = Math.round(width * 0.09);
+    const logoY = Math.round((height - logoSize) / 2);
+    const textX = logoX + logoSize + 60;
+    const top = Math.round(height / 2 - 25);
+
+    const taglineLines = options.tagline
+      .map(
+        (line, index) =>
+          `<text x="${textX + 4}" y="${top + 72 + index * 48}" font-size="38" fill-opacity="0.88">${escapeXml(line)}</text>`,
+      )
+      .join("\n    ");
+
+    const siteY = top + 72 + Math.max(options.tagline.length - 1, 0) * 48 + 80;
+
+    return `<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height}" viewBox="0 0 ${width} ${height}">
+  <rect width="${width}" height="${height}" fill="${options.background}"/>
+  <rect width="${width}" height="10" fill="${options.accent}"/>
+  ${logoAt(logoX, logoY, logoSize)}
+  <g font-family="${fontStack}" fill="#ffffff">
+    <text x="${textX}" y="${top}" font-size="104" font-weight="700">${escapeXml(options.title)}</text>
+    ${taglineLines}
+    <text x="${textX + 4}" y="${siteY}" font-size="30" fill="${options.accent}">${escapeXml(options.site)}</text>
+  </g>
+</svg>`;
+  };
+
+  const square = (size: number, fill?: string) =>
+    `<svg xmlns="http://www.w3.org/2000/svg" width="${size}" height="${size}" viewBox="0 0 ${size} ${size}">
+  ${fill === undefined ? logoAt(0, 0, size) : `<rect width="${size}" height="${size}" fill="${fill}"/>${logoAt(size * 0.1, size * 0.1, size * 0.8)}`}
+</svg>`;
+
+  const { outputs } = options;
+
+  const images = [
+    { file: outputs.socialPreview, render: () => card(1280, 640) },
+    { file: outputs.og, render: () => card(1200, 630) },
+    { file: outputs.logo, render: () => square(512) },
+    {
+      file: outputs.appleTouchIcon,
+      render: () => square(180, options.background),
+    },
+  ];
+
+  const written: string[] = [];
+
+  for (const { file, render } of images) {
+    if (file === undefined) continue;
+    await mkdir(path.dirname(file), { recursive: true });
+    await sharp(Buffer.from(render())).png().toFile(file);
+    written.push(file);
+  }
+
+  return written;
+};

package/src/index.ts

@@ -0,0 +1,5 @@
+export {
+  writeBrandImages,
+  type BrandImageOutputs,
+  type BrandImagesOptions,
+} from "./brand-images.ts";