blume 2.0.2 → 2.1.0

package/dist/types/reference/schema.d.ts

@@ -26,7 +26,7 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
             spec: z.ZodString;
         }, z.core.$strict>>>;
-        codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodArray<z.ZodString>]>>;
         playground: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
             enabled: z.ZodDefault<z.ZodBoolean>;
             proxy: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
@@ -50,14 +50,14 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
         };
         route: string;
         spec?: string | undefined;
-    }, "spec">, {
+    }, "spec" | "overlays">, {
         expandSchemas: boolean;
         sources: {
             includeInLlms: boolean;
@@ -68,7 +68,7 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
@@ -92,7 +92,7 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             spec: z.ZodString;
             endpoint: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>>>;
-        codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodArray<z.ZodString>]>>;
         playground: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
             enabled: z.ZodDefault<z.ZodBoolean>;
             proxy: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
@@ -116,7 +116,7 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             route?: string | undefined;
             endpoint?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
@@ -124,7 +124,7 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
         route: string;
         endpoint?: string | undefined;
         spec?: string | undefined;
-    }, "spec">, {
+    }, "spec" | "overlays">, {
         sources: {
             includeInLlms: boolean;
             includeInSearch: boolean;
@@ -135,7 +135,7 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             route?: string | undefined;
             endpoint?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
@@ -150,6 +150,7 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
     kind: z.ZodLiteral<"openapi">;
     options: z.ZodPipe<z.ZodObject<{
         expandSchemas: z.ZodDefault<z.ZodBoolean>;
+        overlays: z.ZodOptional<z.ZodArray<z.ZodString>>;
         sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
             includeInLlms: z.ZodDefault<z.ZodBoolean>;
             includeInSearch: z.ZodDefault<z.ZodBoolean>;
@@ -158,8 +159,9 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             route: z.ZodOptional<z.ZodString>;
             seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
             spec: z.ZodString;
+            overlays: z.ZodDefault<z.ZodArray<z.ZodString>>;
         }, z.core.$strict>>>;
-        codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodArray<z.ZodString>]>>;
         playground: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
             enabled: z.ZodDefault<z.ZodBoolean>;
             proxy: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
@@ -180,17 +182,19 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             noindex: boolean;
             seoDescriptionSuffix: boolean;
             spec: string;
+            overlays: string[];
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
         };
         route: string;
+        overlays?: string[] | undefined;
         spec?: string | undefined;
-    }, "spec">, {
+    }, "spec" | "overlays">, {
         expandSchemas: boolean;
         sources: {
             includeInLlms: boolean;
@@ -198,15 +202,17 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             noindex: boolean;
             seoDescriptionSuffix: boolean;
             spec: string;
+            overlays: string[];
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
         };
         route: string;
+        overlays?: string[] | undefined;
         spec?: string | undefined;
     }>>;
     requiredSecrets: z.ZodArray<z.ZodString>;
@@ -214,10 +220,12 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
 }, z.core.$strict>, z.ZodObject<{
     kind: z.ZodLiteral<"scalar">;
     options: z.ZodPipe<z.ZodObject<{
+        overlays: z.ZodOptional<z.ZodArray<z.ZodString>>;
         route: z.ZodDefault<z.ZodString>;
         sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
             label: z.ZodOptional<z.ZodString>;
             noindex: z.ZodDefault<z.ZodBoolean>;
+            overlays: z.ZodDefault<z.ZodArray<z.ZodString>>;
             route: z.ZodOptional<z.ZodString>;
             spec: z.ZodString;
         }, z.core.$strict>>>;
@@ -228,10 +236,12 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
         route: string;
         sources: {
             noindex: boolean;
+            overlays: string[];
             spec: string;
             label?: string | undefined;
             route?: string | undefined;
         }[];
+        overlays?: string[] | undefined;
         spec?: string | undefined;
         theme?: string | undefined;
     }>>;
@@ -255,14 +265,14 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
         };
         route: string;
         spec?: string | undefined;
-    }, "spec">;
+    }, "spec" | "overlays">;
     requiredSecrets: string[];
     runtimeDeps: string[];
 } | {
@@ -278,7 +288,7 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             route?: string | undefined;
             endpoint?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
@@ -286,7 +296,7 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
         route: string;
         endpoint?: string | undefined;
         spec?: string | undefined;
-    }, "spec">;
+    }, "spec" | "overlays">;
     requiredSecrets: string[];
     runtimeDeps: string[];
 } | {
@@ -299,17 +309,19 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             noindex: boolean;
             seoDescriptionSuffix: boolean;
             spec: string;
+            overlays: string[];
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
         };
         route: string;
+        overlays?: string[] | undefined;
         spec?: string | undefined;
-    }, "spec">;
+    }, "spec" | "overlays">;
     requiredSecrets: string[];
     runtimeDeps: string[];
 }>>;
@@ -331,7 +343,7 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
             spec: z.ZodString;
         }, z.core.$strict>>>;
-        codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodArray<z.ZodString>]>>;
         playground: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
             enabled: z.ZodDefault<z.ZodBoolean>;
             proxy: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
@@ -355,14 +367,14 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
         };
         route: string;
         spec?: string | undefined;
-    }, "spec">, {
+    }, "spec" | "overlays">, {
         expandSchemas: boolean;
         sources: {
             includeInLlms: boolean;
@@ -373,7 +385,7 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
@@ -397,7 +409,7 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             spec: z.ZodString;
             endpoint: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>>>;
-        codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodArray<z.ZodString>]>>;
         playground: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
             enabled: z.ZodDefault<z.ZodBoolean>;
             proxy: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
@@ -421,7 +433,7 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             route?: string | undefined;
             endpoint?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
@@ -429,7 +441,7 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
         route: string;
         endpoint?: string | undefined;
         spec?: string | undefined;
-    }, "spec">, {
+    }, "spec" | "overlays">, {
         sources: {
             includeInLlms: boolean;
             includeInSearch: boolean;
@@ -440,7 +452,7 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             route?: string | undefined;
             endpoint?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
@@ -455,6 +467,7 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
     kind: z.ZodLiteral<"openapi">;
     options: z.ZodPipe<z.ZodObject<{
         expandSchemas: z.ZodDefault<z.ZodBoolean>;
+        overlays: z.ZodOptional<z.ZodArray<z.ZodString>>;
         sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
             includeInLlms: z.ZodDefault<z.ZodBoolean>;
             includeInSearch: z.ZodDefault<z.ZodBoolean>;
@@ -463,8 +476,9 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             route: z.ZodOptional<z.ZodString>;
             seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
             spec: z.ZodString;
+            overlays: z.ZodDefault<z.ZodArray<z.ZodString>>;
         }, z.core.$strict>>>;
-        codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodArray<z.ZodString>]>>;
         playground: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
             enabled: z.ZodDefault<z.ZodBoolean>;
             proxy: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
@@ -485,17 +499,19 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             noindex: boolean;
             seoDescriptionSuffix: boolean;
             spec: string;
+            overlays: string[];
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
         };
         route: string;
+        overlays?: string[] | undefined;
         spec?: string | undefined;
-    }, "spec">, {
+    }, "spec" | "overlays">, {
         expandSchemas: boolean;
         sources: {
             includeInLlms: boolean;
@@ -503,15 +519,17 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             noindex: boolean;
             seoDescriptionSuffix: boolean;
             spec: string;
+            overlays: string[];
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
         };
         route: string;
+        overlays?: string[] | undefined;
         spec?: string | undefined;
     }>>;
     requiredSecrets: z.ZodArray<z.ZodString>;
@@ -519,10 +537,12 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
 }, z.core.$strict>, z.ZodObject<{
     kind: z.ZodLiteral<"scalar">;
     options: z.ZodPipe<z.ZodObject<{
+        overlays: z.ZodOptional<z.ZodArray<z.ZodString>>;
         route: z.ZodDefault<z.ZodString>;
         sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
             label: z.ZodOptional<z.ZodString>;
             noindex: z.ZodDefault<z.ZodBoolean>;
+            overlays: z.ZodDefault<z.ZodArray<z.ZodString>>;
             route: z.ZodOptional<z.ZodString>;
             spec: z.ZodString;
         }, z.core.$strict>>>;
@@ -533,10 +553,12 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
         route: string;
         sources: {
             noindex: boolean;
+            overlays: string[];
             spec: string;
             label?: string | undefined;
             route?: string | undefined;
         }[];
+        overlays?: string[] | undefined;
         spec?: string | undefined;
         theme?: string | undefined;
     }>>;
@@ -560,14 +582,14 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
         };
         route: string;
         spec?: string | undefined;
-    }, "spec">;
+    }, "spec" | "overlays">;
     requiredSecrets: string[];
     runtimeDeps: string[];
 } | {
@@ -583,7 +605,7 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             route?: string | undefined;
             endpoint?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
@@ -591,7 +613,7 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
         route: string;
         endpoint?: string | undefined;
         spec?: string | undefined;
-    }, "spec">;
+    }, "spec" | "overlays">;
     requiredSecrets: string[];
     runtimeDeps: string[];
 } | {
@@ -604,17 +626,19 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             noindex: boolean;
             seoDescriptionSuffix: boolean;
             spec: string;
+            overlays: string[];
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
         };
         route: string;
+        overlays?: string[] | undefined;
         spec?: string | undefined;
-    }, "spec">;
+    }, "spec" | "overlays">;
     requiredSecrets: string[];
     runtimeDeps: string[];
 }>>>>;

package/dist/types/search/documents.d.ts

@@ -23,6 +23,10 @@ export interface SearchDocument {
      * Filterable through the MCP tools' `filters` input.
      */
     facets?: Record<string, string>;
+    /** Frontmatter `search.boost`: the page's relevance multiplier, when set. */
+    boost?: number;
+    /** Frontmatter `search.keywords`: extra terms the page is found by. */
+    keywords?: string[];
 }
 /**
  * A record uploaded to a hosted search backend (Algolia, Orama Cloud,
@@ -45,6 +49,13 @@ export interface SearchRecord {
     version: string;
     /** Single faceting tag (the first frontmatter tag, when present). */
     tag?: string;
+    /**
+     * The page's relevance multiplier, 1 unless `search.boost` sets it: a
+     * ranking attribute every record carries, so the backend can sort by it.
+     */
+    boost: number;
+    /** Extra terms the page is found by (`search.keywords`). */
+    keywords?: string[];
 }
 interface BuildOptions {
     includeWhenDisabled?: boolean;
@@ -84,7 +95,7 @@ export declare const buildSearchDocuments: (project: BlumeProject, options?: Bui
 /**
  * Map per-page search documents to the flat record shape hosted backends
  * ingest. One record per page, keyed by route; the first tag becomes the
- * faceting `tag`.
+ * faceting `tag`, and every record carries a `boost` (1 by default).
  */
 export declare const toSearchRecords: (documents: SearchDocument[]) => SearchRecord[];
 export {};

package/dist/types/search/orama-index.d.ts

@@ -24,6 +24,10 @@ export interface OramaDoc {
      * but not indexed, so they ride along on the returned document untouched. */
     breadcrumb?: string[];
     section?: string;
+    /** The page's relevance multiplier (`search.boost`); stored, not indexed. */
+    boost?: number;
+    /** Extra terms the page is found by (`search.keywords`). */
+    keywords?: string[];
 }
 /**
  * Build an in-memory Orama full-text index from search documents. Shared by the

package/dist/types/seo/metatags.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Site-wide meta tags (`seo.metatags`): tags written into every page's head,
+ * for what Blume has no setting of its own for, such as site-verification
+ * tokens, `theme-color`, or an app banner. The tags Blume writes itself are
+ * refused, each pointing at the setting that controls it, so a page never
+ * carries two values for one tag.
+ */
+/**
+ * What sets a tag Blume writes itself, or `undefined` for a tag the site can
+ * add.
+ */
+export declare const ownedMetatag: (name: string) => string | undefined;
+/** One site-wide tag, as its `<meta>` element's attributes. */
+export interface MetatagAttributes {
+    content: string;
+    name?: string;
+    property?: string;
+}
+/** The site's `seo.metatags` as `<meta>` attributes, in the order written. */
+export declare const metatagAttributes: (tags?: Readonly<Record<string, string>> | null) => MetatagAttributes[];

package/docs/02-deployment.mdx

@@ -67,6 +67,8 @@ deployment: {
 
 `base` (and `site`) are options of every host adapter too: `vercel({ base: "/docs" })`.
 
+Every page keeps its own path under the base, even in a content folder that shares the base's name: with `base: "/docs"`, `docs/setup.md` is served at `/docs/docs/setup`, and its canonical URL, sidebar link, and `llms.txt` entry point there. A root-relative link you write that already starts with the base is taken to include it and left as written, so link to that page with a relative link (`./docs/setup`) or its full path (`/docs/docs/setup`).
+
 ## Mount the docs under a path
 
 `basePath` mounts every generated route under a segment (`/docs/getting-started`) while leaving the sidebar untouched — the top level is your sections, not a wrapper group. Use it when the docs live at `/docs/*` but the site root stays yours (like Docusaurus `routeBasePath` or Fumadocs `baseUrl`).
@@ -75,7 +77,7 @@ deployment: {
 basePath: "/docs",
 ```
 
-Write links as if mounted at root (`/getting-started`); Blume rewrites them, along with redirects, the sitemap, canonical URLs, Open Graph images, `llms.txt`, and the search index. Public assets (images, files under `public/`) stay at the site root.
+Write links as if mounted at root (`/getting-started`); Blume rewrites them, along with redirects, the sitemap, canonical URLs, Open Graph images, `llms.txt`, and the search index. Public assets (images, files under `public/`) stay at the site root, or under [`base`](#subpath-deploys) when you set one.
 
 This is a distinct concept from the two paths above:
 
@@ -134,6 +136,23 @@ On Vercel and Cloudflare, a server build also turns on [`Accept: text/markdown`
 Server features have their own configuration — for example, the assistant needs a model API key. See the [assistant guide](/docs/configuration/assistant) for setup.
 :::
 
+## Private docs
+
+Blume has no sign-in of its own. A static build is plain files, and anyone who can reach the host can fetch anything in `dist/`. To keep a site private, turn on your host's access protection, which checks every request before a file is served:
+
+- **Vercel**: [Deployment Protection](https://vercel.com/docs/deployment-protection) with the **All Deployments** scope, so production is covered and not only previews. Vercel Authentication lets in members of your Vercel team; Password Protection lets in anyone with a shared password, on paid plans.
+- **Netlify**: [password protection](https://docs.netlify.com/manage/security/secure-access-to-sites/password-protection/) on all deploys, with a shared password, or with team login on Enterprise plans.
+- **Cloudflare**: [Cloudflare Access](https://developers.cloudflare.com/workers/configuration/cloudflare-access/) on the Worker that serves the site (**Workers & Pages**, then your Worker, then **Access**), which covers every domain it answers on. Choose who can sign in by email address, email domain, or Cloudflare account membership.
+- **GitHub Pages**: publish the site privately from an organization on GitHub Enterprise Cloud, and only people with read access to the repository can view it.
+- **Your own server**: put authentication in front of `dist/`, such as nginx's `auth_basic` or an identity-aware proxy.
+
+Host protection works the same for [server builds](#server-rendering). It covers the whole site: to keep some pages public, publish them as a separate site.
+
+Everything Blume writes to `dist/` sits behind the protection, including pages, the search index, the `.md` copies, `llms.txt`, and Open Graph images. A few features reach outside it:
+
+- A hosted [search provider](/docs/configuration/search) (Algolia, Orama Cloud, Typesense, or Mixedbread) keeps its own copy of your content on that service. The built-in Orama, FlexSearch, and Pagefind indexes are files in `dist/`, so they stay private.
+- Services outside the protection can't read your pages. **Open in chat** hands ChatGPT or Claude a link it can't open, link previews in Slack or X can't show your Open Graph cards, and agents can't read `llms.txt` or the MCP server. Set `ai.openInChat: false` to hide the chat actions.
+
 ## Redirects
 
 Map old URLs to new ones in `blume.config.ts`:
@@ -150,12 +169,31 @@ Two hosts need more than the file:
 - **Vercel** reads `vercel.json` from the project's root directory, never from the output directory, so the copy in `dist/` applies only when you deploy that folder itself with the Vercel CLI (`vercel deploy dist`). A Git-connected project never reads it: it serves the redirect pages and none of the headers from [Content types](#content-types). Copy the `redirects` and `headers` from `dist/vercel.json` into the `vercel.json` in your project's root directory, or use `vercel()` for a server build, whose routing config carries the redirects and the discovery headers.
 
 :::note
-`from` and `to` are exact paths — a `:param` segment or `*` wildcard (e.g. `/blog/:slug` or `/old/*`) fails config validation, since hosts disagree on patterns. If you need pattern-based rules, handle them in an infrastructure file like `vercel.json` (which supports wildcard `source` patterns) or your host's redirect config instead. A `vercel.json` you ship in `public/` is preserved as-is.
+Write both `from` and `to` as if mounted at root, starting with `/` (`to` can also be a full `https://` URL) — under [`base`](#subpath-deploys) and [`basePath`](#mount-the-docs-under-a-path) alike, Blume rewrites both sides for you, so a redirect lands inside the base. A `to` that names a file in `public/` (`/files/guide.pdf`) gains `base` but not `basePath`, since that's where the file is served. A base you've already written into `to` by hand is preserved rather than doubled.
 :::
 
-:::note
-Write both `from` and `to` as if mounted at root, starting with `/` (`to` can also be a full `https://` URL) — under [`base`](#subpath-deploys) and [`basePath`](#mount-the-docs-under-a-path) alike, Blume rewrites both sides for you, so a redirect lands inside the base. A base you've already written into `to` by hand is preserved rather than doubled.
-:::
+### Pattern redirects
+
+A `from` can cover many paths at once, written the way Mintlify and `vercel.json` write them:
+
+```ts blume.config.ts
+redirects: [
+  { from: "/beta/:slug*", to: "/v2/:slug*" },
+  { from: "/blog/:slug", to: "/articles/:slug" },
+  { from: "/articles/concepts-*", to: "/concepts" },
+  { from: "/old/article-*", to: "/new/article-*" },
+],
+```
+
+- `:name` matches one whole segment: `/blog/:slug` covers `/blog/hello`, not `/blog/a/b`.
+- `:name*` as the last segment matches the rest of the path, any number of segments: `/beta/:slug*` sends `/beta/guides/setup` to `/v2/guides/setup`, and `/beta` itself to `/v2`. A last segment of `*` does the same.
+- `*` at the end of a segment matches the rest of the path from there: `/articles/concepts-*` covers `/articles/concepts-overview`.
+
+`to` reads a capture by name, as a whole segment (`/:slug*`, `/:slug`), or a `*` for what the `*` in `from` matched (`:splat`, the way `_redirects` spells it, reads it too). A `to` that reads no capture sends every path the pattern covers to one page. An exact redirect wins over a pattern that covers the same path, and patterns are tried in the order you list them.
+
+Each host gets the patterns in its own syntax: splats in `_redirects`, `path-to-regexp` sources in `vercel.json`, and the routing config of a `vercel()` or `netlify()` server build. The `node()` and `cloudflare()` servers match them themselves, and so does `blume dev`. A static build writes no redirect page for a pattern, since it would need one for every path the pattern covers, so a host that reads none of these files (GitHub Pages, say) applies only the exact redirects; `blume-redirects.json` lists patterns as you wrote them.
+
+A pattern can't also match a page: hosts disagree on which of the two answers, so the build stops with `BLUME_REDIRECT_MATCHES_PAGE`, naming the page. Narrow the pattern to the paths that moved.
 
 ## Content types
 
@@ -168,7 +206,7 @@ When a feature needs a runtime secret, Blume warns at `blume dev`/`build` if it'
 | Feature | Variable |
 | --- | --- |
 | Assistant (AI Gateway) | `AI_GATEWAY_API_KEY` (or Vercel OIDC) |
-| Assistant (other adapters) | the adapter's default key env var (`OPENROUTER_API_KEY`, `LLMGATEWAY_API_KEY`, `INKEEP_API_KEY`), or the `apiKeyEnv` you passed it |
+| Assistant (other adapters) | the adapter's default key env var (`OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, `GEMINI_API_KEY`, `XAI_API_KEY`, `OPENROUTER_API_KEY`, `LLMGATEWAY_API_KEY`, `INKEEP_API_KEY`), or the `apiKeyEnv` you passed it |
 | Mixedbread search | `MIXEDBREAD_API_KEY` |
 | [Content sources](/docs/content/sources) | `NOTION_TOKEN` (`notion()`), `SANITY_TOKEN` (`sanity()`), `CONTENTFUL_ACCESS_TOKEN` (`contentful()`), `PAYLOAD_API_KEY` (`payload()`), `STRAPI_API_TOKEN` (`strapi()`), `GITHUB_TOKEN` (`githubReleases()`, and `mdxRemote()` reading from GitHub) |
 

package/docs/03-upgrading.mdx

@@ -6,7 +6,7 @@ sidebar:
   order: 2.5
 ---
 
-Blume 2 changes configuration, not content: your Markdown and MDX pages need no edits, unless one sets the removed `search.boost` frontmatter field (see [Frontmatter](#frontmatter)). Settings that used to be a named string or a keyed block — the search provider, the deployment target, content sources, API references, analytics, and the assistant's model backend — are now **adapters** you import from a `blume/*` subpath and call. Ask AI is renamed the assistant, so `ai.ask` becomes `ai.assistant`. The machine-readable settings move from `ai` to a new `agents` key, and `components.ts` overrides are checked before the build. A zero-config site, or one that sets none of these, only needs the version bump.
+Blume 2 changes configuration, not content: your Markdown and MDX pages need no edits (see [Frontmatter](#frontmatter) for one field that now does something). Settings that used to be a named string or a keyed block — the search provider, the deployment target, content sources, API references, analytics, and the assistant's model backend — are now **adapters** you import from a `blume/*` subpath and call. Ask AI is renamed the assistant, so `ai.ask` becomes `ai.assistant`. The machine-readable settings move from `ai` to a new `agents` key, and `components.ts` overrides are checked before the build. A zero-config site, or one that sets none of these, only needs the version bump.
 
 ## Upgrade with one command
 
@@ -87,7 +87,7 @@ export default defineConfig({
 
 - `netlify()`, `cloudflare()`, and `node()` work the same way. Naming a host adapter switches to server output; pass `output: "static"` to keep a static build with that host's platform files.
 - A config that only sets `site` or `base` stays as it is: `deployment: { site, base }` is still the static form.
-- `redirects` take exact paths. A `from` or `to` with a `:param` segment or a `*` wildcard now fails validation; Blume 1 never supported patterns, and hosts treated them differently. Move pattern rules into your host's own config (`vercel.json`, `_redirects`).
+- `redirects` read `:name` segments and a trailing `*` as patterns, matched the same way on every host (see [Pattern redirects](/docs/deployment#pattern-redirects)). Blume 1 never supported patterns and handed them to each host as written, so check any `from` or `to` that holds one.
 - The `--adapter`, `--output`, and `--base` flags on `blume build` are gone, and passing one stops the build with an error naming the `deployment` setting that replaces it. Set the adapter in `blume.config.ts`, and name it explicitly: server output is no longer inferred from the platform's environment.
 
 See [Deployment](/docs/deployment) for each adapter's options.
@@ -239,7 +239,7 @@ export default defineConfig({
 
 </CodeGroup>
 
-The adapters are `gateway()`, `openrouter()`, `llmgateway()`, `inkeep()`, and `openaiCompatible({ baseUrl, name, model, apiKeyEnv })`. `model`, `apiKeyEnv`, `baseUrl`, `headers`, and `reasoning` move into the adapter; `enabled`, `instructions`, `retrieval`, `suggestions`, `cors`, and `endpoint` move to `ai.assistant` unchanged. Leaving `provider` unset still uses the AI Gateway.
+A 1.x `provider` name maps onto `gateway()`, `openrouter()`, `llmgateway()`, or `inkeep()`, and `openai-compatible` onto `openai({ baseUrl, name, model, apiKeyEnv })`; the [adapter list](/docs/configuration/assistant#adapters) has the rest. `model`, `apiKeyEnv`, `baseUrl`, `headers`, and `reasoning` move into the adapter; `enabled`, `instructions`, `retrieval`, `suggestions`, `cors`, and `endpoint` move to `ai.assistant` unchanged. Leaving `provider` unset still uses the AI Gateway.
 
 The rename reaches every name that said Ask AI:
 
@@ -290,7 +290,7 @@ export default defineConfig({
 
 ## Frontmatter
 
-One frontmatter field is gone: `search.boost`. Blume 1 accepted it, but search never read it, so a page ranked the same without it. Delete it wherever it appears; a page that still sets it fails validation with a hint, and `blume upgrade` lists each one with its file and line.
+Pages keep their frontmatter. One field changes what it does: `search.boost`. Blume 1 accepted it, but search never read it, so a page ranked the same without it. It now multiplies the page's search relevance (see [Ranking](/docs/configuration/search#ranking)). Check any page that sets it: a boost you added and forgot now moves the page up.
 
 ## Component overrides
 

package/docs/04-migrating.mdx

@@ -43,7 +43,7 @@ The agent follows the playbook's workflow from the source's config to a passing
 5. Points your `package.json` scripts at `blume dev` and `blume build`, and swaps the old framework's dependencies for `blume`.
 6. Runs `blume build` and `blume validate` until both pass.
 
-It finishes with a summary of what it migrated, dropped, or approximated, such as footer links or dynamic redirects with no Blume equivalent, so you can decide what to do with each.
+It finishes with a summary of what it migrated, dropped, or approximated, such as footer links or navbar buttons with no Blume equivalent, so you can decide what to do with each.
 
 ## Other agents
 

package/docs/08-faq.mdx

@@ -45,7 +45,7 @@ No. A folder of Markdown is a complete site — navigation, search, and theming
 
 ## Can I use React components and MDX?
 
-Yes. Any page can be `.md` or `.mdx`, and MDX lets you drop in the [built-in components](/docs/content/components) with no imports. You can also add your own `.tsx`/`.jsx` [islands](/docs/content/islands) — Blume auto-enables React only for the pages that use them, so the core theme stays JavaScript-free everywhere else.
+Yes. Any page can be `.md` or `.mdx`, and MDX lets you drop in the [built-in components](/docs/content/components) with no imports. You can also add your own `.tsx`/`.jsx` [islands](/docs/content/islands). Blume switches React on only when your project uses it — any `.tsx` or `.jsx` file in the project (your islands included), a React [`<Component>`](/docs/content/components#component) example, a [component override](/docs/configuration/customization), or the [assistant](/docs/configuration/assistant) — so a site with none of those ships no framework JavaScript.
 
 ## Where can I deploy it?