create-riebeckite 0.0.26 → 0.0.28

package/dist/src/scaffold/readme.d.ts

@@ -0,0 +1,3 @@
+import { type ScaffoldPreset } from "./presets.js";
+import type { SiteTemplateVariables } from "./template_types.js";
+export declare function readme(preset: ScaffoldPreset, variables: SiteTemplateVariables): string;

package/dist/src/scaffold/readme_demos.d.ts

@@ -0,0 +1,27 @@
+import type { ScaffoldPreset } from "./presets.js";
+export type ReadmeDemo = {
+    readonly title: {
+        readonly en: string;
+        readonly ja: string;
+    };
+    readonly intro: {
+        readonly en: string;
+        readonly ja: string;
+    };
+    readonly markdown: string;
+};
+export declare const README_DEMOS: Readonly<Record<string, ReadmeDemo>>;
+/**
+ * English-only content pages keep a `.en` suffix unless `en` is the default
+ * language. `examples` is intentionally absent: it is localized like the
+ * tour pages, with English as the fallback for untranslated languages.
+ */
+export declare const ENGLISH_ONLY_PAGES: Set<string>;
+export declare function fence(language: string, body: string): string;
+export declare function hasPlugin(preset: ScaffoldPreset, packageName: string): boolean;
+/**
+ * A demo key is either `@scope/package` or `@scope/package/topic`. Recover the
+ * package name: the first two `/`-separated segments form the scoped name.
+ */
+export declare function demoPackage(key: string): string;
+export declare const README_DEMO_ORDER: string[];

package/dist/src/scaffold/template-loader.d.ts

@@ -1,4 +1,4 @@
-import type { SiteTemplateFile } from "./templates.js";
+import type { SiteTemplateFile } from "./template_types.js";
 export declare function resolveTemplateRoot(): string;
 export declare function readTemplate(relativePath: string): Uint8Array;
 export declare function copyTemplateTree(relativeDirectory: string, replacements?: Readonly<Record<string, string>>, include?: (relativePath: string) => boolean): SiteTemplateFile[];

package/dist/src/scaffold/template_options.d.ts

@@ -0,0 +1,13 @@
+import type { ScaffoldOptionContext, ScaffoldOptions, ScaffoldPreset } from "./presets.js";
+import type { SiteTemplateVariables } from "./template_types.js";
+/**
+ * Resolve a plugin's options literal for the preset's depth, or `null` when
+ * the plugin takes no options at that depth (and should be called bare).
+ */
+export declare function renderOptions(options: ScaffoldOptions | undefined, context: ScaffoldOptionContext): string | null;
+export declare function pluginExpression(plugin: ScaffoldPreset["plugins"][number], preset: ScaffoldPreset, variables: SiteTemplateVariables): string;
+/**
+ * The options object literal used for a plugin at this preset's depth, or
+ * `null` when it takes no options at that depth.
+ */
+export declare function readmePluginOptions(variables: SiteTemplateVariables, preset: ScaffoldPreset, plugin: ScaffoldPreset["plugins"][number]): string | null;

package/dist/src/scaffold/template_types.d.ts

@@ -0,0 +1,17 @@
+import type { ScaffoldUtilityName } from "./utilities.js";
+export type SiteTemplateVariables = {
+    readonly name: string;
+    readonly title: string;
+    readonly description: string;
+    readonly baseUrl: string;
+    readonly locale: string;
+    readonly externalContent?: boolean;
+};
+export type SiteTemplateOptions = {
+    readonly cloudflareWorkers?: boolean;
+    readonly utilities?: readonly ScaffoldUtilityName[];
+};
+export type SiteTemplateFile = {
+    readonly path: string;
+    readonly content: string | Uint8Array;
+};

package/dist/src/scaffold/templates.d.ts

@@ -1,55 +1,8 @@
-import { type ScaffoldOptionContext, type ScaffoldOptions, type ScaffoldPreset } from "./presets.js";
-import { type ScaffoldUtilityName } from "./utilities.js";
-export type SiteTemplateVariables = {
-    readonly name: string;
-    readonly title: string;
-    readonly description: string;
-    readonly baseUrl: string;
-    readonly locale: string;
-    readonly externalContent?: boolean;
-};
-export type SiteTemplateOptions = {
-    readonly cloudflareWorkers?: boolean;
-    readonly utilities?: readonly ScaffoldUtilityName[];
-};
-export type SiteTemplateFile = {
-    readonly path: string;
-    readonly content: string | Uint8Array;
-};
+import { type ScaffoldPreset } from "./presets.js";
+import type { SiteTemplateFile, SiteTemplateOptions, SiteTemplateVariables } from "./template_types.js";
+export type { SiteTemplateFile, SiteTemplateOptions, SiteTemplateVariables, } from "./template_types.js";
 export declare function siteTemplateFiles(preset: ScaffoldPreset, variables: SiteTemplateVariables, options?: SiteTemplateOptions): readonly SiteTemplateFile[];
 /**
- * Resolve a plugin's options literal for the preset's depth, or `null` when
- * the plugin takes no options at that depth (and should be called bare).
+ * `starter` includes practical configuration and `showcase` renders the full
+ * option surface. Lightweight presets deliberately keep depth 0.
  */
-export declare function renderOptions(options: ScaffoldOptions | undefined, context: ScaffoldOptionContext): string | null;
-export type ReadmeDemo = {
-    readonly title: {
-        readonly en: string;
-        readonly ja: string;
-    };
-    readonly intro: {
-        readonly en: string;
-        readonly ja: string;
-    };
-    readonly markdown: string;
-};
-export declare const README_DEMOS: Readonly<Record<string, ReadmeDemo>>;
-/**
- * English-only content pages keep a `.en` suffix unless `en` is the default
- * language. `examples` is intentionally absent: it is localized like the
- * tour pages, with English as the fallback for untranslated languages.
- */
-export declare const ENGLISH_ONLY_PAGES: Set<string>;
-export declare function fence(language: string, body: string): string;
-export declare function hasPlugin(preset: ScaffoldPreset, packageName: string): boolean;
-/**
- * A demo key is either `@scope/package` or `@scope/package/topic`. Recover the
- * package name: the first two `/`-separated segments form the scoped name.
- */
-export declare function demoPackage(key: string): string;
-/**
- * The options object literal used for a plugin at this preset's depth, or
- * `null` when it takes no options at that depth.
- */
-export declare function readmePluginOptions(variables: SiteTemplateVariables, preset: ScaffoldPreset, plugin: ScaffoldPreset["plugins"][number]): string | null;
-export declare const README_DEMO_ORDER: string[];

package/dist/src/scaffold/utilities.d.ts

@@ -1,4 +1,4 @@
-import type { SiteTemplateFile } from "./templates.js";
+import type { SiteTemplateFile } from "./template_types.js";
 export declare const SCAFFOLD_UTILITY_NAMES: readonly ["gitignore", "editorconfig", "gitattributes", "biome", "npmrc", "vscode"];
 export type ScaffoldUtilityName = (typeof SCAFFOLD_UTILITY_NAMES)[number];
 export type ScaffoldUtilitySummary = {

package/dist/src/scaffold/version.d.ts

@@ -1 +1 @@
-export declare const RIEBECKITE_VERSION = "^0.0.26";
+export declare const RIEBECKITE_VERSION = "^0.0.28";

package/dist/src/scaffold/wrangler-defaults.d.ts

@@ -13,8 +13,6 @@ export declare const CLOUDFLARE_WORKERS_DEFAULTS: {
         readonly directory: "./dist";
     };
 };
-/** Type for the wrangler config object */
-export type CloudflareWorkersDefaults = typeof CLOUDFLARE_WORKERS_DEFAULTS;
 export declare const WRANGLER_VERSION = "^4.83.0";
 export declare const DEFAULT_WORKER_NAME = "riebeckite-site";
 export declare const WORKER_NAME_MAX_LENGTH = 63;
@@ -40,7 +38,5 @@ export declare const LOCKFILE_NAME: "package-lock.json";
 export declare const GITIGNORE_REQUIRED: readonly ["node_modules/", "dist/", ".riebeckite/", "app/.riebeckite/", ".wrangler/", ".dev.vars"];
 /** Files that must NOT be in .gitignore */
 export declare const GITIGNORE_FORBIDDEN: readonly ["package-lock.json"];
-/** Starter preset content pages (base names without language suffixes) */
-export declare const STARTER_CONTENT_PAGES: readonly ["index", "guide", "examples", "notes/planning", "notes/writing"];
 /** Starter preset languages */
 export declare const STARTER_LANGUAGES: readonly ["en", "ja", "zh-CN", "es", "de", "fr", "ko"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-riebeckite",
-  "version": "0.0.26",
+  "version": "0.0.28",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/src/index.js",
@@ -39,7 +39,7 @@
   },
   "devDependencies": {
     "esbuild": "^0.28.2",
-    "@riebeckite/test": "0.0.26"
+    "@riebeckite/test": "0.0.28"
   },
   "repository": {
     "type": "git",

package/templates/scaffold/deployment/github-actions/deploy.yml

@@ -11,6 +11,9 @@ concurrency:
   group: riebeckite-deploy
   cancel-in-progress: true
 
+env:
+  NODE_VERSION: "22"
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -23,7 +26,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 22
+          node-version: ${{ env.NODE_VERSION }}
           cache: npm
 
       - name: Install dependencies
@@ -31,14 +34,27 @@ jobs:
 
       - name: Restore Riebeckite build state
         uses: actions/cache@v4
+        continue-on-error: true
         with:
           path: |
             .riebeckite/cache
             .riebeckite/build/content-state.json
-          key: riebeckite-build-v1-${{ runner.os }}-${{ hashFiles('package-lock.json') }}-${{ github.run_id }}-${{ github.run_attempt }}
+            .riebeckite/ssg-output-cache.json
+            .riebeckite/ssg-output-cache.entries
+            .riebeckite/ssg-output-cache.fast-path.json
+          key: riebeckite-build-v2-${{ runner.os }}-node${{ env.NODE_VERSION }}-${{ hashFiles('package-lock.json') }}-${{ hashFiles('riebeckite.config.ts') }}-${{ github.run_id }}-${{ github.run_attempt }}
           restore-keys: |
-            riebeckite-build-v1-${{ runner.os }}-${{ hashFiles('package-lock.json') }}-
-            riebeckite-content-v3-${{ runner.os }}-${{ hashFiles('package-lock.json') }}
+            riebeckite-build-v2-${{ runner.os }}-node${{ env.NODE_VERSION }}-${{ hashFiles('package-lock.json') }}-${{ hashFiles('riebeckite.config.ts') }}-
+            riebeckite-build-v2-${{ runner.os }}-node${{ env.NODE_VERSION }}-${{ hashFiles('package-lock.json') }}-
+
+      - name: Report restored Riebeckite cache
+        shell: bash
+        run: |
+          if [ -d .riebeckite ]; then
+            echo "Restored Riebeckite cache: $(du -sb .riebeckite | cut -f1) bytes"
+          else
+            echo "Restored Riebeckite cache: 0 bytes (cold build)"
+          fi
 
       - name: Validate configuration and plugins
         run: npm exec riebeckite check
@@ -46,6 +62,11 @@ jobs:
       - name: Build the site
         run: npm exec riebeckite build
 
+      - name: Report Riebeckite cache to save
+        shell: bash
+        run: |
+          echo "Riebeckite cache to save: $(du -sb .riebeckite | cut -f1) bytes"
+
       - name: Deploy the built assets
         uses: cloudflare/wrangler-action@v3
         with:

package/templates/scaffold/presets/empty/app/style.css

@@ -1,14 +1,4 @@
-
-*,
-*::before,
-*::after {
-  box-sizing: border-box;
-}
-
-body {
-  margin: 0;
-  font-family: system-ui, sans-serif;
-}
+@import "./.riebeckite/framework-styles.css";
 
 .riebeckite-empty {
   max-width: 48rem;

package/templates/scaffold/presets/minimal/app/style.css

@@ -2,17 +2,6 @@
 @import "./.riebeckite/plugin-styles.css";
 @import "./.riebeckite/theme-styles.css";
 
-*,
-*::before,
-*::after {
-  box-sizing: border-box;
-}
-
-body {
-  margin: 0;
-  font-family: system-ui, sans-serif;
-}
-
 .riebeckite-page {
   display: flex;
   min-height: 100vh;

package/templates/scaffold/presets/showcase/app/components/site-header.tsx

@@ -1,4 +1,4 @@
-import { SiteNav } from "@riebeckite/plugin-navigation";
+import { MobileSiteNav, SiteNav } from "@riebeckite/plugin-navigation";
 import { ColorModeToggle } from "@riebeckite/plugin-color-mode";
 import { useSiteContext } from "@riebeckite/ui";
 
@@ -17,11 +17,12 @@ export function SiteHeader() {
         />
         {site?.config.site.title}
       </a>
-      <SiteNav placement="primary" omitHome />
-      <details class="rb-nav__mobile">
-        <summary class="rb-nav__toggle">Menu</summary>
+      <div class="site-header__primary-navigation">
         <SiteNav placement="primary" omitHome />
-      </details>
+      </div>
+      <div class="site-header__mobile-navigation">
+        <MobileSiteNav placement="primary" omitHome />
+      </div>
       <ColorModeToggle />
     </header>
   );

package/templates/scaffold/presets/showcase/app/style.css

@@ -2,17 +2,6 @@
 @import "./.riebeckite/plugin-styles.css";
 @import "./.riebeckite/theme-styles.css";
 
-*,
-*::before,
-*::after {
-  box-sizing: border-box;
-}
-
-body {
-  margin: 0;
-  font-family: system-ui, sans-serif;
-}
-
 .riebeckite-page {
   --site-toc-sticky-top: var(--rb-space-3, 1.5rem);
   display: flex;
@@ -43,7 +32,7 @@ body {
 }
 
 .site-header,
-.rb-site-footer {
+.site-footer {
   width: min(100% - 2rem, var(--rb-layout-page-max, 80rem));
 }
 
@@ -57,51 +46,17 @@ body {
   text-decoration: none;
 }
 
-.rb-nav {
-  color: var(--rb-color-ink);
-}
-
-.rb-nav > .rb-nav__list {
-  display: flex;
-  align-items: center;
-  gap: var(--rb-space-3, 1.5rem);
-}
-
-.rb-nav__link {
-  color: inherit;
-  text-decoration: none;
-}
-
-.rb-nav__link:hover,
-.rb-nav__link:focus-visible,
-.rb-nav__link--active {
-  color: var(--rb-color-accent);
-}
-
-.rb-nav__link:focus-visible,
-.rb-nav__toggle:focus-visible {
-  outline: 2px solid var(--rb-color-accent);
-  outline-offset: 2px;
-}
-
-.rb-nav__children {
-  padding: var(--rb-space-2, 1rem);
-  background: var(--rb-color-surface);
-  border: 1px solid var(--rb-color-border);
-}
-
-.rb-nav__mobile {
+.site-header__mobile-navigation {
   display: none;
 }
 
-.rb-site-footer {
+.site-footer {
   margin-top: 1rem;
   border-top: 1px solid var(--rb-color-border);
 }
 
 @media (min-width: 30.001rem) and (max-width: 48rem) {
-  .rb-site-header,
-  .rb-nav > .rb-nav__list {
+  .site-header {
     flex-wrap: wrap;
   }
 }
@@ -111,51 +66,17 @@ body {
     padding-block: var(--rb-space-3, 1.5rem);
   }
 
-  .rb-site-header {
+  .site-header {
     flex-wrap: wrap;
   }
 
-  .rb-site-header > .rb-nav {
+  .site-header__primary-navigation {
     display: none;
   }
 
-  .rb-nav__mobile {
-    position: relative;
+  .site-header__mobile-navigation {
     display: block;
   }
-
-  .rb-nav__mobile > .rb-nav {
-    position: absolute;
-    z-index: 10;
-    top: calc(100% + var(--rb-space-2, 1rem));
-    right: 0;
-    min-width: 12rem;
-    padding: var(--rb-space-3, 1.5rem);
-    background: var(--rb-color-surface);
-    border: 1px solid var(--rb-color-border);
-    box-shadow: 0 4px 12px
-      color-mix(in oklab, var(--rb-color-ink) 14%, transparent);
-  }
-
-  .rb-nav__mobile .rb-nav__list,
-  .rb-nav__mobile .rb-nav__children {
-    display: flex;
-    flex-direction: column;
-    align-items: flex-start;
-    gap: var(--rb-space-2, 1rem);
-  }
-
-  .rb-nav__mobile .rb-nav__list {
-    padding: 0;
-  }
-
-  .rb-nav__mobile .rb-nav__children {
-    position: static;
-    margin-top: var(--rb-space-2, 1rem);
-    padding: 0;
-    background: transparent;
-    border: 0;
-  }
 }
 
 .site-header__logo {
@@ -174,29 +95,37 @@ body {
   margin: 0 auto;
 }
 
-.rb-article-body,
-.site-article__footer {
+.rb-article-body {
   min-width: 0;
   padding-inline: var(--rb-space-2, 1rem);
 }
 
+.site-article__footer {
+  min-width: 0;
+}
+
 .site-article__aside {
   display: none;
 }
 
-@media (min-width: 64rem) {
+@media (min-width: 80rem) {
   .site-article__layout {
     display: grid;
     width: 100%;
-    grid-template-columns: minmax(0, var(--rb-layout-article-max, 48rem)) minmax(0, var(--rb-layout-sidebar, 14rem));
-    gap: var(--rb-layout-gap, 2rem);
+    grid-template-columns: minmax(0, 1fr) minmax(0, var(--rb-layout-article-max, 48rem)) minmax(0, 1fr);
     align-items: start;
   }
 
+  .site-article__layout > .rb-article-body {
+    grid-column: 2;
+  }
+
   .site-article__aside {
     display: block;
     min-width: 0;
     align-self: stretch;
+    grid-column: 3;
+    padding-inline-start: var(--rb-layout-gap, 2rem);
   }
 
   .site-article__aside > .rr-table-of-contents--desktop {

package/templates/scaffold/presets/starter/app/components/site-header.tsx

@@ -1,4 +1,4 @@
-import { SiteNav } from "@riebeckite/plugin-navigation";
+import { MobileSiteNav, SiteNav } from "@riebeckite/plugin-navigation";
 import { ColorModeToggle } from "@riebeckite/plugin-color-mode";
 import { useSiteContext } from "@riebeckite/ui";
 
@@ -17,11 +17,12 @@ export function SiteHeader() {
         />
         {site?.config.site.title}
       </a>
-      <SiteNav placement="primary" omitHome />
-      <details class="rb-nav__mobile">
-        <summary class="rb-nav__toggle">Menu</summary>
+      <div class="site-header__primary-navigation">
         <SiteNav placement="primary" omitHome />
-      </details>
+      </div>
+      <div class="site-header__mobile-navigation">
+        <MobileSiteNav placement="primary" omitHome />
+      </div>
       <ColorModeToggle />
     </header>
   );

package/templates/scaffold/presets/starter/app/style.css

@@ -2,17 +2,6 @@
 @import "./.riebeckite/plugin-styles.css";
 @import "./.riebeckite/theme-styles.css";
 
-*,
-*::before,
-*::after {
-  box-sizing: border-box;
-}
-
-body {
-  margin: 0;
-  font-family: system-ui, sans-serif;
-}
-
 .riebeckite-page {
   --site-toc-sticky-top: var(--rb-space-3, 1.5rem);
   display: flex;
@@ -43,7 +32,7 @@ body {
 }
 
 .site-header,
-.rb-site-footer {
+.site-footer {
   width: min(100% - 2rem, var(--rb-layout-page-max, 80rem));
 }
 
@@ -57,51 +46,17 @@ body {
   text-decoration: none;
 }
 
-.rb-nav {
-  color: var(--rb-color-ink);
-}
-
-.rb-nav > .rb-nav__list {
-  display: flex;
-  align-items: center;
-  gap: var(--rb-space-3, 1.5rem);
-}
-
-.rb-nav__link {
-  color: inherit;
-  text-decoration: none;
-}
-
-.rb-nav__link:hover,
-.rb-nav__link:focus-visible,
-.rb-nav__link--active {
-  color: var(--rb-color-accent);
-}
-
-.rb-nav__link:focus-visible,
-.rb-nav__toggle:focus-visible {
-  outline: 2px solid var(--rb-color-accent);
-  outline-offset: 2px;
-}
-
-.rb-nav__children {
-  padding: var(--rb-space-2, 1rem);
-  background: var(--rb-color-surface);
-  border: 1px solid var(--rb-color-border);
-}
-
-.rb-nav__mobile {
+.site-header__mobile-navigation {
   display: none;
 }
 
-.rb-site-footer {
+.site-footer {
   margin-top: 1rem;
   border-top: 1px solid var(--rb-color-border);
 }
 
 @media (min-width: 30.001rem) and (max-width: 48rem) {
-  .rb-site-header,
-  .rb-nav > .rb-nav__list {
+  .site-header {
     flex-wrap: wrap;
   }
 }
@@ -111,51 +66,17 @@ body {
     padding-block: var(--rb-space-3, 1.5rem);
   }
 
-  .rb-site-header {
+  .site-header {
     flex-wrap: wrap;
   }
 
-  .rb-site-header > .rb-nav {
+  .site-header__primary-navigation {
     display: none;
   }
 
-  .rb-nav__mobile {
-    position: relative;
+  .site-header__mobile-navigation {
     display: block;
   }
-
-  .rb-nav__mobile > .rb-nav {
-    position: absolute;
-    z-index: 10;
-    top: calc(100% + var(--rb-space-2, 1rem));
-    right: 0;
-    min-width: 12rem;
-    padding: var(--rb-space-3, 1.5rem);
-    background: var(--rb-color-surface);
-    border: 1px solid var(--rb-color-border);
-    box-shadow: 0 4px 12px
-      color-mix(in oklab, var(--rb-color-ink) 14%, transparent);
-  }
-
-  .rb-nav__mobile .rb-nav__list,
-  .rb-nav__mobile .rb-nav__children {
-    display: flex;
-    flex-direction: column;
-    align-items: flex-start;
-    gap: var(--rb-space-2, 1rem);
-  }
-
-  .rb-nav__mobile .rb-nav__list {
-    padding: 0;
-  }
-
-  .rb-nav__mobile .rb-nav__children {
-    position: static;
-    margin-top: var(--rb-space-2, 1rem);
-    padding: 0;
-    background: transparent;
-    border: 0;
-  }
 }
 
 .site-header__logo {
@@ -174,29 +95,37 @@ body {
   margin: 0 auto;
 }
 
-.rb-article-body,
-.site-article__footer {
+.rb-article-body {
   min-width: 0;
   padding-inline: var(--rb-space-2, 1rem);
 }
 
+.site-article__footer {
+  min-width: 0;
+}
+
 .site-article__aside {
   display: none;
 }
 
-@media (min-width: 64rem) {
+@media (min-width: 80rem) {
   .site-article__layout {
     display: grid;
     width: 100%;
-    grid-template-columns: minmax(0, var(--rb-layout-article-max, 48rem)) minmax(0, var(--rb-layout-sidebar, 14rem));
-    gap: var(--rb-layout-gap, 2rem);
+    grid-template-columns: minmax(0, 1fr) minmax(0, var(--rb-layout-article-max, 48rem)) minmax(0, 1fr);
     align-items: start;
   }
 
+  .site-article__layout > .rb-article-body {
+    grid-column: 2;
+  }
+
   .site-article__aside {
     display: block;
     min-width: 0;
     align-self: stretch;
+    grid-column: 3;
+    padding-inline-start: var(--rb-layout-gap, 2rem);
   }
 
   .site-article__aside > .rr-table-of-contents--desktop {