create-zudo-doc 3.2.0 → 3.3.0

package/templates/base/src/config/i18n.ts

@@ -1,239 +0,0 @@
-import { settings } from "./settings";
-import type { LocaleConfig } from "./settings-types";
-
-// Collection name string used by zfb's content engine (`getCollection(...)`).
-// Kept as a structural string-literal alias so callers don't have to redeclare
-// it; it's a structural type so the underlying engine is interchangeable.
-type CollectionKey = string;
-
-/** Default locale code, served from docsDir. */
-export const defaultLocale = settings.defaultLocale;
-
-/** All supported locale codes, derived from settings. */
-export const locales = [
-  defaultLocale,
-  ...(Object.keys(settings.locales) as Array<keyof typeof settings.locales>),
-] as const;
-export type Locale = (typeof locales)[number];
-
-/** Safely look up a locale in settings.locales by string key. */
-export function getLocaleConfig(locale: string): LocaleConfig | undefined {
-  return (settings.locales as Record<string, LocaleConfig | undefined>)[locale];
-}
-
-/** Get the content directory for a locale. */
-export function getContentDir(locale: Locale | string): string {
-  if (locale === defaultLocale) return settings.docsDir;
-  return getLocaleConfig(locale)?.dir ?? settings.docsDir;
-}
-
-/**
- * Get the Astro content collection name for a locale.
- * Returns a CollectionKey so it can be passed directly to getCollection().
- * The cast is safe because collections are dynamically created in content.config.ts
- * for every locale in settings.locales.
- */
-export function getCollectionName(locale: Locale | string): CollectionKey {
-  if (locale === defaultLocale) return "docs";
-  return `docs-${locale}` as CollectionKey;
-}
-
-/** Get the display label for a locale. */
-export function getLocaleLabel(locale: Locale | string): string {
-  if (locale === defaultLocale) return defaultLocale.toUpperCase();
-  return getLocaleConfig(locale)?.label ?? locale.toUpperCase();
-}
-
-/** Detect locale from a URL pathname (after base stripping). */
-export function detectLocaleFromPath(path: string): Locale {
-  for (const code of Object.keys(settings.locales)) {
-    if (path.startsWith(`/${code}/`) || path === `/${code}`) {
-      return code as Locale;
-    }
-  }
-  return defaultLocale;
-}
-
-/** UI string translations */
-export const translations: Record<string, Record<string, string>> = {
-  en: {
-    "nav.gettingStarted": "Getting Started",
-    "nav.learn": "Learn",
-    "nav.guides": "Guides",
-    "nav.components": "Components",
-    "nav.reference": "Reference",
-    "nav.claude": "Claude",
-    "nav.changelog": "Changelog",
-    "nav.develop": "Develop",
-    "nav.previous": "Previous",
-    "nav.next": "Next",
-    "nav.overview": "Overview",
-    "toc.title": "On this page",
-    "docs.browseAll": "Browse all documentation sections.",
-    "search.label": "Search",
-    "search.placeholder": "Type to search...",
-    "search.shortcutHint": "to open search from anywhere",
-    "search.resultCount": "{count} results",
-    "search.unavailable": "Search unavailable",
-    "search.loadingIndex": "Loading search index…",
-    "search.noResults": "No results found.",
-    "code.copy": "Copy code",
-    "code.copied": "Copied!",
-    "code.wrapToggle": "Toggle word wrap",
-    "doc.editPage": "Edit this page",
-    "doc.viewSource": "View source on GitHub",
-    "header.github": "GitHub repository",
-    "doc.tags": "Tags",
-    "doc.taggedWith": "Pages tagged with",
-    "doc.allTags": "All Tags",
-    "doc.created": "Created",
-    "doc.updated": "Updated",
-    "doc.noTags": "No tags found.",
-    "doc.pageCount": "{count} pages",
-    "doc.pageCountSingle": "{count} page",
-    "nav.backToMenu": "Back to main menu",
-    "doc.fallbackNotice":
-      "This page has not been translated yet and is shown in the original language.",
-    "frontmatter.preview.title": "Frontmatter",
-    "frontmatter.preview.keyCol": "Key",
-    "frontmatter.preview.valueCol": "Value",
-    "version.latest": "Latest",
-    "version.switcher.label": "Version",
-    "version.banner.unmaintained":
-      "You are viewing documentation for an older version.",
-    "version.banner.unreleased":
-      "You are viewing unreleased documentation.",
-    "version.banner.latestLink": "View the latest version",
-    "version.switcher.unavailable": "Not available in this version",
-    "version.switcher.allVersions": "All versions",
-    "version.page.title": "Documentation Versions",
-    "version.page.latest.title": "Latest Version (Current)",
-    "version.page.latest.description":
-      "The most up-to-date documentation for the latest stable release.",
-    "version.page.latest.link": "View latest docs",
-    "version.page.past.title": "Past Versions",
-    "version.page.past.description":
-      "Documentation for previously released versions.",
-    "version.page.unmaintained": "Unmaintained",
-    "version.page.unreleased": "Unreleased",
-    "version.page.status": "Status",
-    "version.page.docs": "Docs",
-  },
-  ja: {
-    "nav.gettingStarted": "はじめに",
-    "nav.learn": "学ぶ",
-    "nav.guides": "ガイド",
-    "nav.components": "コンポーネント",
-    "nav.reference": "リファレンス",
-    "nav.claude": "Claude",
-    "nav.changelog": "変更履歴",
-    "nav.develop": "開発",
-    "nav.previous": "前へ",
-    "nav.next": "次へ",
-    "nav.overview": "概要",
-    "toc.title": "目次",
-    "docs.browseAll": "すべてのドキュメントセクションを閲覧",
-    "search.label": "検索",
-    "search.placeholder": "検索したい単語を入力",
-    "search.shortcutHint": "いつでも検索バーを開ける",
-    "search.resultCount": "{count} 件",
-    "search.unavailable": "検索を利用できません",
-    "search.loadingIndex": "検索インデックスを読み込み中…",
-    "search.noResults": "検索結果が見つかりませんでした。",
-    "code.copy": "コードをコピー",
-    "code.copied": "コピーしました！",
-    "code.wrapToggle": "折り返し切替",
-    "doc.editPage": "このページを編集",
-    "doc.viewSource": "GitHub でソースを見る",
-    "header.github": "GitHub リポジトリ",
-    "doc.tags": "タグ",
-    "doc.taggedWith": "タグ付きページ",
-    "doc.allTags": "すべてのタグ",
-    "doc.created": "作成",
-    "doc.updated": "更新",
-    "doc.noTags": "タグが見つかりません。",
-    "doc.pageCount": "{count}ページ",
-    "doc.pageCountSingle": "{count}ページ",
-    "nav.backToMenu": "メインメニューに戻る",
-    "doc.fallbackNotice":
-      "このページはまだ翻訳されていません。原文のまま表示しています。",
-    "frontmatter.preview.title": "フロントマター",
-    "frontmatter.preview.keyCol": "キー",
-    "frontmatter.preview.valueCol": "値",
-    "version.latest": "最新",
-    "version.switcher.label": "バージョン",
-    "version.banner.unmaintained":
-      "これは旧バージョンのドキュメントです。",
-    "version.banner.unreleased":
-      "これは未リリースのドキュメントです。",
-    "version.banner.latestLink": "最新バージョンを見る",
-    "version.switcher.unavailable": "このバージョンでは利用できません",
-    "version.switcher.allVersions": "すべてのバージョン",
-    "version.page.title": "ドキュメントバージョン",
-    "version.page.latest.title": "最新バージョン（現在）",
-    "version.page.latest.description":
-      "最新の安定版リリースのドキュメントです。",
-    "version.page.latest.link": "最新ドキュメントを見る",
-    "version.page.past.title": "過去のバージョン",
-    "version.page.past.description":
-      "以前にリリースされたバージョンのドキュメントです。",
-    "version.page.unmaintained": "メンテナンス終了",
-    "version.page.unreleased": "未リリース",
-    "version.page.status": "ステータス",
-    "version.page.docs": "ドキュメント",
-  },
-  de: {
-    "nav.gettingStarted": "Erste Schritte",
-    "nav.learn": "Lernen",
-    "nav.guides": "Anleitungen",
-    "nav.components": "Komponenten",
-    "nav.reference": "Referenz",
-    "nav.claude": "Claude",
-    "nav.changelog": "Changelog",
-    "nav.develop": "Entwicklung",
-    "nav.previous": "Zurück",
-    "nav.next": "Weiter",
-    "nav.overview": "Überblick",
-    "toc.title": "Auf dieser Seite",
-    "docs.browseAll": "Alle Dokumentationsabschnitte durchsuchen.",
-    "search.label": "Suche",
-    "search.placeholder": "Suchbegriff eingeben...",
-    "search.shortcutHint": "Suche von überall öffnen",
-    "search.resultCount": "{count} Ergebnisse",
-    "search.unavailable": "Suche nicht verfügbar",
-    "search.loadingIndex": "Suchindex wird geladen…",
-    "search.noResults": "Keine Ergebnisse gefunden.",
-    "code.copy": "Code kopieren",
-    "code.copied": "Kopiert!",
-    "code.wrapToggle": "Zeilenumbruch umschalten",
-    "nav.backToMenu": "Zurück zum Hauptmenü",
-    "doc.editPage": "Diese Seite bearbeiten",
-    "doc.viewSource": "Quellcode auf GitHub ansehen",
-    "header.github": "GitHub-Repository",
-    "doc.tags": "Tags",
-    "doc.taggedWith": "Seiten mit Tag",
-    "doc.allTags": "Alle Tags",
-    "doc.created": "Erstellt",
-    "doc.updated": "Aktualisiert",
-    "doc.noTags": "Keine Tags gefunden.",
-    "doc.pageCount": "{count} Seiten",
-    "doc.pageCountSingle": "{count} Seite",
-    "doc.fallbackNotice":
-      "Diese Seite wurde noch nicht übersetzt und wird in der Originalsprache angezeigt.",
-    "frontmatter.preview.title": "Frontmatter",
-    "frontmatter.preview.keyCol": "Schlüssel",
-    "frontmatter.preview.valueCol": "Wert",
-    "version.latest": "Neueste",
-    "version.switcher.label": "Version",
-    "version.banner.unmaintained":
-      "Sie sehen die Dokumentation einer älteren Version.",
-    "version.banner.unreleased":
-      "Sie sehen unveröffentlichte Dokumentation.",
-    "version.banner.latestLink": "Neueste Version anzeigen",
-  },
-};
-
-/** Get a translated UI string */
-export function t(key: string, locale: Locale | string = defaultLocale): string {
-  return translations[locale]?.[key] ?? translations[defaultLocale]?.[key] ?? key;
-}

package/templates/base/src/config/settings-types.ts

@@ -1,45 +0,0 @@
-// Re-export most types from the shared package — moved to @takazudo/zudo-doc/settings
-// as part of the package-first migration (epic #2321, S4 #2327).
-// HeaderRightTriggerName and HeaderRightTriggerItem are defined locally rather than
-// re-exported from the package because the designTokenPanel feature injects its
-// extra trigger-name variant into HeaderRightTriggerName via the @slot anchor; the
-// package unconditionally includes both trigger names but the base template
-// ships only "ai-chat", and the feature overlay adds the panel trigger variant
-// via the compose engine.  HeaderRightTriggerItem references the local
-// HeaderRightTriggerName, so it stays local too.
-export type {
-  TagGovernanceMode,
-  TagVocabularyEntry,
-  HeaderNavChildItem,
-  HeaderNavItem,
-  HeaderRightComponentName,
-  HeaderRightComponentItem,
-  HeaderRightLinkItem,
-  HeaderRightHtmlItem,
-  HeaderRightItem,
-  BodyFootUtilAreaConfig,
-  ColorModeConfig,
-  LocaleConfig,
-  FooterLinkItem,
-  FooterLinkColumn,
-  FooterTaglistLocaleConfig,
-  FooterTaglistConfig,
-  FooterConfig,
-  HtmlPreviewConfig,
-  FrontmatterPreviewConfig,
-  TagPlacement,
-  VersionConfig,
-  ChangelogConfig,
-  MetaTagsConfig,
-  SiteHeadConfig,
-  Settings,
-} from "@takazudo/zudo-doc/settings";
-
-// @slot:settings-types:trigger-names:start
-export type HeaderRightTriggerName = "ai-chat";
-// @slot:settings-types:trigger-names:end
-
-export interface HeaderRightTriggerItem {
-  type: "trigger";
-  trigger: HeaderRightTriggerName;
-}

package/templates/base/src/config/sidebars.ts

@@ -1,66 +0,0 @@
-/**
- * Sidebar configuration file.
- *
- * Items can be:
- * - "autogenerated" — auto-scan a directory (default behavior)
- * - doc references with optional overrides
- * - external links
- * - category groupings
- *
- * If this file exports an empty object or the key for a section is not found,
- * the sidebar falls back to filesystem-based auto-generation.
- */
-
-export interface SidebarLink {
-  type: "link";
-  label: string;
-  href: string;
-}
-
-export interface SidebarDoc {
-  type: "doc";
-  id: string; // doc slug, e.g. "getting-started/introduction"
-  label?: string; // override the doc's title in sidebar
-}
-
-export interface SidebarCategory {
-  type: "category";
-  label: string;
-  items: SidebarItem[];
-  collapsed?: boolean;
-  sortOrder?: "asc" | "desc";
-}
-
-export interface SidebarAutogenerated {
-  type: "autogenerated";
-  dirName?: string; // subdirectory to scan (optional)
-}
-
-export type SidebarItem =
-  | SidebarDoc
-  | SidebarLink
-  | SidebarCategory
-  | SidebarAutogenerated
-  | string;
-
-// String shorthand: "getting-started/introduction" is equivalent to
-// { type: "doc", id: "getting-started/introduction" }
-
-export interface SidebarsConfig {
-  [sectionKey: string]: SidebarItem[] | undefined;
-}
-
-/**
- * Sidebar configuration.
- * Keys correspond to headerNav categoryMatch values.
- * If a section has no config here, it uses auto-generated filesystem sidebar.
- */
-const sidebars: SidebarsConfig = {
-  // Example:
-  // "!": [
-  //   { type: "autogenerated" },
-  //   { type: "link", label: "GitHub", href: "https://github.com/..." },
-  // ],
-};
-
-export default sidebars;

package/templates/base/src/config/tag-vocabulary-types.ts

@@ -1,4 +0,0 @@
-// Re-export from the shared package — canonical definitions live in
-// @takazudo/zudo-doc/settings (epic #2321). Consumers that import from
-// this local path continue to work unchanged.
-export type { TagGovernanceMode, TagVocabularyEntry } from "@takazudo/zudo-doc/settings";

package/templates/base/src/config/tag-vocabulary.ts

@@ -1,20 +0,0 @@
-import type { TagVocabularyEntry } from "./tag-vocabulary-types";
-
-/**
- * Canonical tag vocabulary for this documentation base.
- *
- * Populate this array with the tags you use in `src/content/docs/**`.
- * Then enable `tagGovernance: "warn"` (or `"strict"`) and
- * `tagVocabulary: true` in `settings.ts` to activate alias resolution,
- * deprecation filtering, and grouped tag rendering.
- *
- * Example entry:
- *
- *     {
- *       id: "type:guide",
- *       label: "Guide",
- *       group: "type",
- *       aliases: ["guide", "guides"],
- *     }
- */
-export const tagVocabulary: readonly TagVocabularyEntry[] = [];

package/templates/base/src/config/z-index-tokens.ts

@@ -1,128 +0,0 @@
-// z-index design tokens — single source of truth.
-//
-// This file is the ONE place z-index tiers are defined. The CSS `@theme` block
-// in `src/styles/global.css` is GENERATED from this list by the
-// `gen-z-index` bin from `@takazudo/zudo-doc` (run `pnpm gen:z-index`); never
-// hand-edit the generated block. `pnpm check:z-index` re-runs the generator
-// into a buffer and fails on drift, so the committed CSS can never silently
-// diverge from this list.
-//
-// Strategy (from zudolab/zudo-css-wisdom z-index-strategy): semantic single-
-// namespace tokens — names describe ROLES, never magnitudes. One flat ordered
-// list. Values are deliberately gapped but otherwise arbitrary: renaming and
-// reordering is cheap, which is the whole point. Tailwind v4 reads the
-// `--z-index-<name>` theme key and generates a `z-<name>` utility, so e.g.
-// `@theme { --z-index-toolbar: 20 }` produces `.z-toolbar { z-index: 20 }`.
-//
-// `kind` distinguishes:
-//   - "global": a tier on the single global stacking scale (overlay chrome etc.)
-//   - "local":  anonymous reusable helpers for promoting a child WITHIN a parent
-//               stacking context (`isolation: isolate` / `position: relative`),
-//               not a position on the global scale.
-//
-// Rationale for the two zudo-doc-specific additions (NOT in the generic
-// overlay-centric strategy scale):
-//   - `sidebar` — persistent layout chrome (desktop sidebar, TOC, sidebar-toggle
-//     handle, resizer handle). The strategy's scale has no persistent-sidebar/TOC
-//     tier. `toolbar` (the sticky header) is deliberately placed ABOVE `sidebar`
-//     to preserve the existing header-wins ordering; they do not overlap
-//     spatially, but the historical relationship is kept explicit.
-//   - `drag` — transient drag affordance (sidebar-resizer ghost line). Replaces
-//     the old `z-9999` anti-pattern with a named top-of-steady-UI tier.
-//
-// `popover`, `toast`, and `tooltip` are reserved canonical tiers from the
-// strategy's scale — kept for completeness (and so downstream `create-zudo-doc`
-// users inherit the full scale) even though zudo-doc does not use them yet.
-
-export type ZIndexKind = "global" | "local";
-
-export interface ZIndexTier {
-  name: string;
-  value: number;
-  purpose: string;
-  kind: ZIndexKind;
-}
-
-export const Z_INDEX_TIERS: ZIndexTier[] = [
-  {
-    name: "content",
-    value: 0,
-    purpose: "default in-flow content (implicit baseline)",
-    kind: "global",
-  },
-  {
-    name: "local-1",
-    value: 1,
-    purpose: "child promotion inside an isolated parent stacking context",
-    kind: "local",
-  },
-  {
-    name: "local-2",
-    value: 2,
-    purpose: "child promotion inside an isolated parent stacking context",
-    kind: "local",
-  },
-  {
-    name: "local-3",
-    value: 3,
-    purpose: "child promotion inside an isolated parent stacking context",
-    kind: "local",
-  },
-  {
-    name: "sidebar",
-    value: 10,
-    purpose:
-      "persistent layout chrome: desktop sidebar, TOC, sidebar-toggle handle, resizer handle",
-    kind: "global",
-  },
-  {
-    name: "toolbar",
-    value: 20,
-    purpose: "sticky top header (sits above sidebar chrome)",
-    kind: "global",
-  },
-  {
-    name: "dropdown",
-    value: 30,
-    purpose: "header menus, version/language switchers",
-    kind: "global",
-  },
-  {
-    name: "popover",
-    value: 40,
-    purpose: "reserved — inline popovers (canonical scale; not yet used)",
-    kind: "global",
-  },
-  {
-    name: "modal-backdrop",
-    value: 50,
-    purpose: "mobile drawer backdrop, <dialog> ::backdrop",
-    kind: "global",
-  },
-  {
-    name: "modal",
-    value: 60,
-    purpose: "mobile sidebar drawer panel, search <dialog>",
-    kind: "global",
-  },
-  {
-    name: "toast",
-    value: 70,
-    purpose: "reserved — transient notifications (canonical scale; not yet used)",
-    kind: "global",
-  },
-  {
-    name: "tooltip",
-    value: 80,
-    purpose:
-      "reserved — highest steady UI layer, below only the transient drag tier (canonical scale; not yet used)",
-    kind: "global",
-  },
-  {
-    name: "drag",
-    value: 90,
-    purpose:
-      "transient drag affordance: sidebar-resizer ghost line (replaces the z-9999 anti-pattern)",
-    kind: "global",
-  },
-];

package/templates/base/src/types/docs-entry.ts

@@ -1,28 +0,0 @@
-import type { DocsData } from "@/config/docs-schema";
-
-/**
- * Concrete entry type for docs collections.
- *
- * Mirrors the public surface that pages consume from `getCollection(...)`.
- * Originally this was structurally identical to Astro's `CollectionEntry`
- * but is defined locally now that the project runs on the zfb content
- * engine — collection-name-specific generics are not exposed by zfb, so
- * pages cast collection entries to this shape via `pages/_data.ts`.
- *
- * `data` is typed as `DocsData` — the `z.infer`-derived type from
- * `src/config/docs-schema.ts` — so the field set is maintained in one place.
- */
-// Structural shape of zfb's optional rendered-content payload for a doc
-// entry (kept loose to stay engine-agnostic — pages do not rely on the
-// exact field set today).
-type RenderedContent = unknown;
-export interface DocsEntry {
-  id: string;
-  /** zfb content engine slug (filename without `.md`/`.mdx`; used by toRouteSlug). */
-  slug: string;
-  body?: string;
-  collection: string;
-  data: DocsData;
-  rendered?: RenderedContent;
-  filePath?: string;
-}

package/templates/base/src/types/heading.ts

@@ -1,5 +0,0 @@
-export interface Heading {
-  depth: number;
-  slug: string;
-  text: string;
-}

package/templates/base/src/types/locale.ts

@@ -1,10 +0,0 @@
-/**
- * Represents a locale switcher link.
- * Used by both SidebarFooter (Preact) and language-switcher (Preact).
- */
-export interface LocaleLink {
-  code: string;
-  label: string;
-  href: string;
-  active: boolean;
-}