@heyo-sh/create-heyo-docs 1.0.0 → 2.0.0

package/templates/next/content/openapi.json

@@ -1,278 +0,0 @@
-{
-  "openapi": "3.1.0",
-  "info": {
-    "title": "Planet API",
-    "version": "1.0.0",
-    "description": "An example API used by the Heyo Docs React Router demo."
-  },
-  "servers": [
-    {
-      "url": "https://api.example.com/v1",
-      "description": "Example production API"
-    }
-  ],
-  "security": [
-    {
-      "BearerAuth": []
-    }
-  ],
-  "paths": {
-    "/organizations/{organizationId}/planets": {
-      "parameters": [
-        {
-          "name": "organizationId",
-          "in": "path",
-          "required": true,
-          "description": "The organization that owns the planets.",
-          "schema": {
-            "type": "string",
-            "example": "org_123"
-          }
-        }
-      ],
-      "get": {
-        "operationId": "listPlanets",
-        "summary": "List planets",
-        "description": "Returns the planets that belong to an organization.",
-        "tags": ["Planets"],
-        "parameters": [
-          {
-            "name": "limit",
-            "in": "query",
-            "description": "Maximum number of records to return.",
-            "schema": {
-              "type": "integer",
-              "default": 20
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "A page of planets.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "array",
-                  "items": {
-                    "$ref": "#/components/schemas/Planet"
-                  }
-                }
-              }
-            }
-          }
-        }
-      },
-      "post": {
-        "operationId": "createPlanet",
-        "summary": "Create a planet",
-        "description": "Creates a planet inside an organization.",
-        "tags": ["Planets"],
-        "requestBody": {
-          "required": true,
-          "description": "The planet to create.",
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/PlanetInput"
-              }
-            }
-          }
-        },
-        "responses": {
-          "201": {
-            "description": "The newly created planet.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Planet"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/organizations/{organizationId}/planets/{planetId}": {
-      "parameters": [
-        {
-          "name": "organizationId",
-          "in": "path",
-          "required": true,
-          "description": "The organization that owns the planet.",
-          "schema": {
-            "type": "string",
-            "example": "org_123"
-          }
-        },
-        {
-          "name": "planetId",
-          "in": "path",
-          "required": true,
-          "description": "The planet identifier.",
-          "schema": {
-            "type": "string",
-            "example": "planet_earth"
-          }
-        }
-      ],
-      "get": {
-        "operationId": "getPlanet",
-        "summary": "Get a planet",
-        "description": "Returns one planet by ID.",
-        "tags": ["Planets"],
-        "responses": {
-          "200": {
-            "description": "The requested planet.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Planet"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "Planet not found."
-          }
-        }
-      },
-      "put": {
-        "operationId": "replacePlanet",
-        "summary": "Replace a planet",
-        "description": "Replaces all editable planet values.",
-        "tags": ["Planets"],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/PlanetInput"
-              }
-            }
-          }
-        },
-        "responses": {
-          "200": {
-            "description": "The updated planet.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Planet"
-                }
-              }
-            }
-          }
-        }
-      },
-      "patch": {
-        "operationId": "updatePlanet",
-        "summary": "Update a planet",
-        "description": "Updates one or more planet fields.",
-        "tags": ["Planets"],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/PlanetPatch"
-              }
-            }
-          }
-        },
-        "responses": {
-          "200": {
-            "description": "The updated planet.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Planet"
-                }
-              }
-            }
-          }
-        }
-      },
-      "delete": {
-        "operationId": "deletePlanet",
-        "summary": "Delete a planet",
-        "description": "Permanently removes a planet from an organization.",
-        "tags": ["Planets"],
-        "parameters": [
-          {
-            "name": "hardDelete",
-            "in": "query",
-            "description": "Also remove historical records.",
-            "schema": {
-              "type": "boolean",
-              "default": false
-            }
-          }
-        ],
-        "responses": {
-          "204": {
-            "description": "Planet deleted."
-          },
-          "404": {
-            "description": "Planet not found."
-          }
-        }
-      }
-    }
-  },
-  "components": {
-    "securitySchemes": {
-      "BearerAuth": {
-        "type": "http",
-        "scheme": "bearer",
-        "bearerFormat": "JWT"
-      }
-    },
-    "schemas": {
-      "Planet": {
-        "type": "object",
-        "required": ["id", "name", "classification"],
-        "properties": {
-          "id": {
-            "type": "string",
-            "example": "planet_earth"
-          },
-          "name": {
-            "type": "string",
-            "example": "Earth"
-          },
-          "classification": {
-            "type": "string",
-            "enum": ["terrestrial", "gas-giant", "ice-giant"]
-          }
-        }
-      },
-      "PlanetInput": {
-        "type": "object",
-        "required": ["name", "classification"],
-        "properties": {
-          "name": {
-            "type": "string",
-            "example": "Mars"
-          },
-          "classification": {
-            "type": "string",
-            "enum": ["terrestrial", "gas-giant", "ice-giant"]
-          }
-        }
-      },
-      "PlanetPatch": {
-        "type": "object",
-        "properties": {
-          "name": {
-            "type": "string",
-            "example": "New Mars"
-          },
-          "classification": {
-            "type": "string",
-            "enum": ["terrestrial", "gas-giant", "ice-giant"]
-          }
-        }
-      }
-    }
-  }
-}

package/templates/next/content/quickstart.mdx

@@ -1,60 +0,0 @@
----
-title: Quickstart
-description: Create, run, and understand your Heyo Docs project.
----
-
-# Quickstart
-
-A new Heyo Docs project is a complete documentation site: MDX files provide the
-content, `heyo-docs.config.ts` defines the site model, and your selected
-framework renders the finished experience.
-
-## Create a project
-
-Use the creator with the package manager you already use. It asks for a project
-name, framework, deployment target, theme, and package manager, then creates a
-ready-to-run application.
-
-<CodeBlockGroup defaultValue="bun" variant="line">
-  <CodeBlock language="bash" title="bun">
-    {"bun create @heyo-sh/heyo-docs"}
-  </CodeBlock>
-  <CodeBlock language="bash" title="npm">
-    {"npm create @heyo-sh/heyo-docs@latest"}
-  </CodeBlock>
-  <CodeBlock language="bash" title="pnpm">
-    {"pnpm create @heyo-sh/heyo-docs"}
-  </CodeBlock>
-  <CodeBlock language="bash" title="yarn">
-    {"yarn dlx @heyo-sh/create-heyo-docs"}
-  </CodeBlock>
-</CodeBlockGroup>
-
-When the command finishes, move into the new directory and run the development
-command printed by the creator. The local server rebuilds the documentation
-when you change either content or configuration.
-
-## How the pieces fit together
-
-1. **Content** lives in the `content` directory. Every `.mdx` file becomes a
-   documentation route.
-2. **Configuration** in `heyo-docs.config.ts` gives the site its name, theme,
-   navigation order, and public metadata.
-3. **The framework app** loads the same model during development and production
-   builds, so the sidebar, search, routes, and adjacent-page links stay in sync.
-
-Create a new file such as `content/guides/deployment.mdx` to add the
-`/guides/deployment` route. Add that path to a navigation section when the
-page should appear in the sidebar.
-
-## Make your first change
-
-Update the title and description in the frontmatter of `content/index.mdx`,
-then refresh the browser. Use [Basic Configuration](/configuration) to adjust
-the site model and [Text Styling](/essentials/text-styling) for writing the
-page itself.
-
-<Callout type="tip" title="One source of truth">
-  Keep navigation in <code>heyo-docs.config.ts</code> and page-specific details
-  in MDX frontmatter. The build validates both before publishing.
-</Callout>

package/templates/react-router/app/components/theme-provider.tsx

@@ -1,106 +0,0 @@
-import {
-  createContext,
-  useContext,
-  useEffect,
-  useState,
-  type ReactNode,
-} from "react";
-
-import {
-  applyTheme,
-  DEFAULT_THEME,
-  getStoredTheme,
-  type ResolvedTheme,
-  THEME_STORAGE_KEY,
-  type Theme,
-} from "../lib/theme";
-
-type ThemeProviderProps = {
-  children: ReactNode;
-  defaultTheme?: Theme;
-  storageKey?: string;
-};
-
-type ThemeProviderState = {
-  theme: Theme;
-  resolvedTheme: ResolvedTheme;
-  mounted: boolean;
-  setTheme: (theme: Theme) => void;
-};
-
-const ThemeProviderContext = createContext<ThemeProviderState | undefined>(
-  undefined,
-);
-
-export function ThemeProvider({
-  children,
-  defaultTheme = DEFAULT_THEME,
-  storageKey = THEME_STORAGE_KEY,
-}: ThemeProviderProps) {
-  const [theme, setThemeState] = useState<Theme>(defaultTheme);
-  const [resolvedTheme, setResolvedTheme] = useState<ResolvedTheme>(
-    defaultTheme === "system" ? "light" : defaultTheme,
-  );
-  const [mounted, setMounted] = useState(false);
-
-  useEffect(() => {
-    const syncTheme = () => {
-      const nextTheme = getStoredTheme(storageKey, defaultTheme);
-
-      setThemeState(nextTheme);
-      setResolvedTheme(applyTheme(nextTheme));
-    };
-
-    syncTheme();
-
-    const mediaQuery = window.matchMedia("(prefers-color-scheme: dark)");
-    const handleSystemThemeChange = () => {
-      const nextTheme = getStoredTheme(storageKey, defaultTheme);
-      setResolvedTheme(applyTheme(nextTheme));
-    };
-    const handleStorage = (event: StorageEvent) => {
-      if (event.key !== null && event.key !== storageKey) return;
-      syncTheme();
-    };
-
-    mediaQuery.addEventListener("change", handleSystemThemeChange);
-    window.addEventListener("storage", handleStorage);
-    setMounted(true);
-
-    return () => {
-      mediaQuery.removeEventListener("change", handleSystemThemeChange);
-      window.removeEventListener("storage", handleStorage);
-    };
-  }, [defaultTheme, storageKey]);
-
-  const value = {
-    theme,
-    resolvedTheme,
-    mounted,
-    setTheme: (nextTheme: Theme) => {
-      try {
-        window.localStorage.setItem(storageKey, nextTheme);
-      } catch {
-        // The requested preference still applies when storage is unavailable.
-      }
-
-      setThemeState(nextTheme);
-      setResolvedTheme(applyTheme(nextTheme));
-    },
-  };
-
-  return (
-    <ThemeProviderContext.Provider value={value}>
-      {children}
-    </ThemeProviderContext.Provider>
-  );
-}
-
-export function useTheme() {
-  const context = useContext(ThemeProviderContext);
-
-  if (context === undefined)
-    throw new Error("useTheme must be used within a ThemeProvider");
-
-  return context;
-}

package/templates/react-router/app/lib/theme.ts

@@ -1,74 +0,0 @@
-export type Theme = "dark" | "light" | "system";
-export type ResolvedTheme = Exclude<Theme, "system">;
-
-export const DEFAULT_THEME: Theme = "system";
-export const THEME_STORAGE_KEY = "heyo-docs-theme";
-
-const themeValues = new Set<Theme>(["light", "dark", "system"]);
-
-export function isTheme(value: string | null): value is Theme {
-  return value !== null && themeValues.has(value as Theme);
-}
-
-export function getStoredTheme(
-  storageKey: string,
-  fallbackTheme: Theme,
-): Theme {
-  if (typeof window === "undefined") return fallbackTheme;
-
-  try {
-    const storedTheme = window.localStorage.getItem(storageKey);
-    return isTheme(storedTheme) ? storedTheme : fallbackTheme;
-  } catch {
-    return fallbackTheme;
-  }
-}
-
-export function getSystemTheme(): ResolvedTheme {
-  return window.matchMedia("(prefers-color-scheme: dark)").matches
-    ? "dark"
-    : "light";
-}
-
-export function resolveTheme(theme: Theme): ResolvedTheme {
-  return theme === "system" ? getSystemTheme() : theme;
-}
-
-export function applyTheme(theme: Theme): ResolvedTheme {
-  const resolvedTheme = resolveTheme(theme);
-  const root = window.document.documentElement;
-
-  root.classList.remove("light", "dark");
-  root.classList.add(resolvedTheme);
-  root.style.colorScheme = resolvedTheme;
-
-  return resolvedTheme;
-}
-
-export function getThemeScript(storageKey: string, defaultTheme: Theme) {
-  return `(() => {
-  const storageKey = ${JSON.stringify(storageKey)};
-  const fallbackTheme = ${JSON.stringify(defaultTheme)};
-  const isTheme = (value) => value === "light" || value === "dark" || value === "system";
-
-  const storedTheme = (() => {
-    try {
-      const value = window.localStorage.getItem(storageKey);
-      return isTheme(value) ? value : fallbackTheme;
-    } catch {
-      return fallbackTheme;
-    }
-  })();
-
-  const resolvedTheme = storedTheme === "system"
-    ? window.matchMedia("(prefers-color-scheme: dark)").matches
-      ? "dark"
-      : "light"
-    : storedTheme;
-
-  const root = document.documentElement;
-  root.classList.remove("light", "dark");
-  root.classList.add(resolvedTheme);
-  root.style.colorScheme = resolvedTheme;
-})();`;
-}

package/templates/react-router/content/api-overview.mdx

@@ -1,20 +0,0 @@
----
-title: API overview
-description: Learn how to authenticate and explore the API reference.
----
-
-# API overview
-
-The API reference is generated from `openapi.json`. Use the endpoint pages to
-enter parameters, send a request, and copy a cURL or JavaScript example.
-
-## Authentication
-
-The example API uses a Bearer token. Enter it once on any protected endpoint;
-Heyo Docs keeps it in this browser while you move between API pages.
-
-## Custom pages first
-
-This ordinary MDX page belongs to the OpenAPI group. Its section is configured
-before the generated endpoint sections, so it always appears at the top of the
-sidebar.

package/templates/react-router/content/assets/local-architecture.svg

@@ -1,22 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="960" height="360" viewBox="0 0 960 360" fill="none">
-  <rect width="960" height="360" rx="24" fill="#F7F7F8"/>
-  <g fill="#FFFFFF" stroke="#D4D4D8" stroke-width="2">
-    <rect x="72" y="108" width="220" height="144" rx="18"/>
-    <rect x="370" y="108" width="220" height="144" rx="18"/>
-    <rect x="668" y="108" width="220" height="144" rx="18"/>
-  </g>
-  <g fill="#18181B" font-family="Arial, sans-serif" text-anchor="middle">
-    <text x="182" y="166" font-size="17" font-weight="700">Content</text>
-    <text x="182" y="194" font-size="14" fill="#71717A">MDX and assets</text>
-    <text x="480" y="166" font-size="17" font-weight="700">Build</text>
-    <text x="480" y="194" font-size="14" fill="#71717A">Vite bundles files</text>
-    <text x="778" y="166" font-size="17" font-weight="700">Documentation</text>
-    <text x="778" y="194" font-size="14" fill="#71717A">Static output</text>
-  </g>
-  <g stroke="#71717A" stroke-linecap="round" stroke-width="2">
-    <path d="M314 180h34"/>
-    <path d="m340 172 8 8-8 8"/>
-    <path d="M612 180h34"/>
-    <path d="m638 172 8 8-8 8"/>
-  </g>
-</svg>

package/templates/react-router/content/assets/quick-reference.txt

@@ -1,5 +0,0 @@
-Heyo Docs quick reference
-
-- Put MDX pages and local assets in content.
-- Use a relative path to bundle an image or downloadable file.
-- Use /path for assets in public.

package/templates/react-router/content/changelog.mdx

@@ -1,38 +0,0 @@
----
-title: Changelog
-description: Mock release notes for the Heyo Docs example.
----
-
-# Changelog
-
-<Update label="April 2026" tags={["New", "Documentation"]}>
-
-## Starter documentation
-
-New projects and runnable examples now include a structured Quickstart, basic
-configuration guide, deployment overview, and essential writing patterns.
-
-## Square API group
-
-The example navigation now keeps the pinned Square OpenAPI schema in its own
-group, making large-schema behaviour easy to inspect.
-
-</Update>
-
-<Update label="March 2026" tags={["Improved", "Developer experience"]}>
-
-## Clearer navigation
-
-External documentation links can display an icon, and sidebar groups now keep
-onboarding, API reference, and release notes separate.
-
-</Update>
-
-<Update label="February 2026" tags={["Fixed"]}>
-
-## More predictable previews
-
-Preview builds now validate configured routes before mock release notes are
-published.
-
-</Update>