@heyo-sh/create-heyo-docs 3.0.0 → 3.2.0

package/README.md

@@ -29,15 +29,15 @@ The creator works with pnpm, npm, Yarn, and Bun.
 Passing options makes the creator non-interactive; include a project-directory
 argument when using them in automation.
 
-| Option              | Values                          |
-| ------------------- | ------------------------------- |
-| `--template`        | `react-router`, `next`, `astro` |
-| `--theme`           | `grain`, `shade`, `moss`        |
-| `--deployment`      | `cloudflare`, `vercel`, `later` |
-| `--package-manager` | `bun`, `pnpm`, `npm`, `yarn`    |
-| `--no-install`      | Skip dependency installation    |
-
-Read the [full documentation](https://docs.heyo.sh) for configuration, content, components, framework integrations, and deployment.
+| Option              | Values                           |
+| ------------------- | -------------------------------- |
+| `--template`        | `react-router`, `next`, `astro`  |
+| `--theme`           | `grain`, `shade`, `moss`, `heyo` |
+| `--deployment`      | `cloudflare`, `vercel`, `later`  |
+| `--package-manager` | `bun`, `pnpm`, `npm`, `yarn`     |
+| `--no-install`      | Skip dependency installation     |
+
+Read the [full documentation](https://heyo.sh) for configuration, content, components, framework integrations, and deployment.
 
 ## License
 

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAeA,OAAO,KAAK,EAAE,aAAa,EAAY,MAAM,SAAS,CAAC;AAEvD,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAChE,mBAAmB,SAAS,CAAC;AAqD7B,wBAAsB,GAAG,CAAC,IAAI,WAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,CAwBrE;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG;IAC9C,OAAO,EAAE,aAAa,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAsDA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAeA,OAAO,KAAK,EAAE,aAAa,EAAY,MAAM,SAAS,CAAC;AAEvD,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAChE,mBAAmB,SAAS,CAAC;AAsD7B,wBAAsB,GAAG,CAAC,IAAI,WAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,CAwBrE;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG;IAC9C,OAAO,EAAE,aAAa,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAsDA"}

package/dist/index.js

@@ -198,7 +198,7 @@ async function installDependencies(projectPath, packageManager) {
 }
 
 // src/index.ts
-var USAGE = "Usage: create-heyo-docs [project-name] [--template react-router|next|astro] [--deployment cloudflare|vercel|later] [--theme grain|shade|moss] [--package-manager bun|pnpm|npm|yarn] [--no-install]";
+var USAGE = "Usage: create-heyo-docs [project-name] [--template react-router|next|astro] [--deployment cloudflare|vercel|later] [--theme grain|shade|moss|heyo] [--package-manager bun|pnpm|npm|yarn] [--no-install]";
 var TEMPLATE_OPTIONS = [
   { value: "react-router", label: "React Router" },
   { value: "next", label: "Next.js" },
@@ -213,6 +213,7 @@ var THEME_OPTIONS = [
   { value: "grain", label: "Grain" },
   { value: "shade", label: "Shade" },
   { value: "moss", label: "Moss" },
+  { value: "heyo", label: "Heyo" },
   {
     value: "dripper",
     label: "Dripper — Soon",
@@ -292,7 +293,7 @@ function parseArguments(argv) {
     } else if (value === "--deployment") {
       options.deployment = readEnum(argv[++index], ["cloudflare", "vercel", "later"], "deployment");
     } else if (value === "--theme") {
-      options.theme = readEnum(argv[++index], ["grain", "shade", "moss"], "theme");
+      options.theme = readEnum(argv[++index], ["grain", "shade", "moss", "heyo"], "theme");
     } else if (value === "--package-manager") {
       options.packageManager = readEnum(argv[++index], ["bun", "pnpm", "npm", "yarn"], "package manager");
     } else if (value === "--no-install") {
@@ -324,7 +325,8 @@ async function askQuestions(defaults) {
   const theme = await selectAvailable("Theme", THEME_OPTIONS, [
     "grain",
     "shade",
-    "moss"
+    "moss",
+    "heyo"
   ]);
   const packageManager = await selectAvailable("Package manager", PACKAGE_MANAGER_OPTIONS, ["bun", "pnpm", "npm", "yarn"], defaults.packageManager);
   const install = promptValue(await p.confirm({

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 export type Template = "react-router" | "next" | "astro";
 export type Deployment = "cloudflare" | "vercel" | "later";
-export type Theme = "grain" | "shade" | "moss";
+export type Theme = "grain" | "shade" | "moss" | "heyo";
 export type PackageManager = "bun" | "pnpm" | "npm" | "yarn";
 export interface CreateOptions {
     projectName: string;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,cAAc,GAAG,MAAM,GAAG,OAAO,CAAC;AACzD,MAAM,MAAM,UAAU,GAAG,YAAY,GAAG,QAAQ,GAAG,OAAO,CAAC;AAC3D,MAAM,MAAM,KAAK,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;AAC/C,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;AAE7D,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,EAAE,KAAK,CAAC;IACb,cAAc,EAAE,cAAc,CAAC;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,cAAc,GAAG,MAAM,GAAG,OAAO,CAAC;AACzD,MAAM,MAAM,UAAU,GAAG,YAAY,GAAG,QAAQ,GAAG,OAAO,CAAC;AAC3D,MAAM,MAAM,KAAK,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AACxD,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;AAE7D,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,EAAE,KAAK,CAAC;IACb,cAAc,EAAE,cAAc,CAAC;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heyo-sh/create-heyo-docs",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "Create a standalone Heyo Docs documentation project.",
   "homepage": "https://heyo.sh",
   "repository": {
@@ -27,7 +27,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@clack/prompts": "1.8.0"
+    "@clack/prompts": "1.8.1"
   },
   "scripts": {
     "dev": "bun run build --watch",

package/templates/astro/src/pages/robots.txt.ts

@@ -10,6 +10,7 @@ export const GET: APIRoute = ({ request }) => {
       "User-agent: *",
       "Allow: /",
       "Disallow: /__heyo-docs/",
+      "Disallow: /heyo-docs-internal/",
       "",
       `Sitemap: ${siteUrl}/sitemap.xml`,
       "",

package/templates/next/app/robots.txt/route.ts

@@ -7,6 +7,7 @@ export function GET(request: Request) {
       "User-agent: *",
       "Allow: /",
       "Disallow: /__heyo-docs/",
+      "Disallow: /heyo-docs-internal/",
       "",
       `Sitemap: ${siteUrl}/sitemap.xml`,
       "",

package/templates/react-router/app/routes/docs.tsx

@@ -5,10 +5,7 @@ import {
   findOpenApiEndpoint,
 } from "@heyo-sh/heyo-docs/model";
 import { changelogGroupForPage } from "@heyo-sh/heyo-docs/navigation";
-import {
-  openApiEndpointDataPath,
-  openApiEndpointDetail,
-} from "@heyo-sh/heyo-docs/openapi";
+import { openApiEndpointDetail } from "@heyo-sh/heyo-docs/openapi";
 import { docsSeoMeta } from "@heyo-sh/heyo-docs/seo/react-router";
 import type { OpenApiEndpoint } from "@heyo-sh/heyo-docs/types";
 import { useDocsTheme } from "@heyo-sh/heyo-docs/theme/provider";
@@ -16,6 +13,7 @@ import {
   Link,
   useLoaderData,
   useParams,
+  type ClientLoaderFunctionArgs,
   type LoaderFunctionArgs,
   type MetaFunction,
 } from "react-router";
@@ -48,33 +46,38 @@ export async function loader({ params }: LoaderFunctionArgs) {
 
   if (!endpoint) return {};
 
-  // Prerendering serialises this operation-specific data with its static route,
-  // so the browser's first paint already contains the complete API reference.
-  if (typeof window === "undefined") {
-    const serverModel = createDocsModel(config, pages, openApiDocuments);
-    const currentOpenApiEndpoint = findOpenApiEndpoint(
-      serverModel.endpoints,
-      pathname,
-    );
-    return {
-      currentOpenApiEndpoint: currentOpenApiEndpoint
-        ? openApiEndpointDetail(currentOpenApiEndpoint)
-        : undefined,
-    };
-  }
-
-  // Client transitions wait for the static shard before committing the new
-  // route. This prevents rendering the compact index and replacing it later.
-  const response = await fetch(openApiEndpointDataPath(endpoint.slug));
-  if (!response.ok)
-    throw new Response("OpenAPI endpoint data could not be loaded", {
-      status: response.status,
-    });
+  // This loader runs on the server, including during prerendering, so the
+  // operation's full data is serialised with the route. First paint and every
+  // client transition therefore start from the complete API reference.
+  const serverModel = createDocsModel(config, pages, openApiDocuments);
+  const currentOpenApiEndpoint = findOpenApiEndpoint(
+    serverModel.endpoints,
+    pathname,
+  );
   return {
-    currentOpenApiEndpoint: (await response.json()) as OpenApiEndpoint,
+    currentOpenApiEndpoint: currentOpenApiEndpoint
+      ? (openApiEndpointDetail(currentOpenApiEndpoint) as OpenApiEndpoint)
+      : undefined,
   };
 }
 
+/**
+ * Loads the page's MDX chunk before the new route is displayed, so a reader
+ * never sees a loading placeholder replace the page they came from.
+ */
+export async function clientLoader({
+  params,
+  serverLoader,
+}: ClientLoaderFunctionArgs) {
+  const model = createDocsModel(config, pages, [], openApiEndpoints);
+  const page = findDocsPage(model.pages, pathnameFor(params));
+  const [data] = await Promise.all([
+    serverLoader<Awaited<ReturnType<typeof loader>>>(),
+    page?.preload?.(),
+  ]);
+  return data;
+}
+
 export const meta: MetaFunction = ({ params }) => {
   const model = createDocsModel(config, pages, [], openApiEndpoints);
   const pathname = pathnameFor(params);

package/templates/react-router/app/routes/page.tsx

@@ -1 +1 @@
-export { default, loader, meta, ErrorBoundary } from "./docs";
+export { default, clientLoader, loader, meta, ErrorBoundary } from "./docs";

package/templates/react-router/app/routes/robots.ts

@@ -10,6 +10,7 @@ export function loader({ request }: Route.LoaderArgs) {
       "User-agent: *",
       "Allow: /",
       "Disallow: /__heyo-docs/",
+      "Disallow: /heyo-docs-internal/",
       "",
       `Sitemap: ${siteUrl}/sitemap.xml`,
       "",