@dogsbay/docs-layout 0.2.0-beta.0

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@dogsbay/docs-layout",
+  "version": "0.2.0-beta.0",
+  "description": "Standard documentation layout components for Dogsbay",
+  "type": "module",
+  "exports": {
+    "./DocsLayout.astro": "./src/DocsLayout.astro",
+    "./DocsSidebar.astro": "./src/DocsSidebar.astro",
+    "./DocsHeader.astro": "./src/DocsHeader.astro",
+    "./DocsToc.astro": "./src/DocsToc.astro",
+    "./DocsFooter.astro": "./src/DocsFooter.astro",
+    "./DocsNav.astro": "./src/DocsNav.astro",
+    "./TagList.astro": "./src/TagList.astro",
+    "./StatusBadge.astro": "./src/StatusBadge.astro",
+    "./TypeBadge.astro": "./src/TypeBadge.astro",
+    "./TaxonomyIndex.astro": "./src/TaxonomyIndex.astro",
+    "./TaxonomyTerm.astro": "./src/TaxonomyTerm.astro",
+    "./SearchDialog.astro": "./src/SearchDialog.astro",
+    "./PageActions.astro": "./src/PageActions.astro",
+    "./pagination": "./src/pagination.ts",
+    "./markdown-negotiation": "./src/markdown-negotiation.ts",
+    "./version-redirect": "./src/version-redirect.ts",
+    "./switcher": "./src/switcher.ts",
+    "./LocaleSwitcher.astro": "./src/LocaleSwitcher.astro",
+    "./nav-filter": "./src/nav-filter.ts",
+    "./search-facets": "./src/search-facets.ts",
+    "./tag-list-data": "./src/tag-list-data.ts",
+    "./llm-actions": "./src/llm-actions.ts",
+    "./json-ld": "./src/json-ld.ts"
+  },
+  "dependencies": {
+    "@dogsbay/ui": "0.2.0-beta.0",
+    "@dogsbay/primitives": "0.2.0-beta.0"
+  },
+  "devDependencies": {
+    "vitest": "^3.0.0"
+  },
+  "peerDependencies": {
+    "astro": "^5.0.0 || ^6.0.0"
+  },
+  "files": [
+    "src",
+    "README.md"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dogsbay/dogsbay.git",
+    "directory": "packages/docs-layout"
+  },
+  "homepage": "https://github.com/dogsbay/dogsbay/tree/main/packages/docs-layout",
+  "bugs": {
+    "url": "https://github.com/dogsbay/dogsbay/issues"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}

package/src/DocsFooter.astro

@@ -0,0 +1,96 @@
+---
+/**
+ * Documentation page footer.
+ * Edit link, last updated, prev/next pagination.
+ */
+
+interface PaginationLink {
+  label: string;
+  href: string;
+}
+
+interface Props {
+  editUrl?: string;
+  lastUpdated?: string;
+  prev?: PaginationLink;
+  next?: PaginationLink;
+  copyright?: string;
+  /**
+   * When true, render a low-key footer link to `/llms.txt` so
+   * agents and humans alike can discover the LLM index. Standard
+   * practice across Vercel / Stripe / Drizzle. See
+   * plans/llm-page-actions.md.
+   */
+  llmsLink?: boolean;
+  /** Path to llms.txt. Default `/llms.txt`. */
+  llmsLinkHref?: string;
+  class?: string;
+}
+
+const {
+  editUrl,
+  lastUpdated,
+  prev,
+  next,
+  copyright,
+  llmsLink = false,
+  llmsLinkHref = "/llms.txt",
+  class: className,
+} = Astro.props;
+---
+
+<footer class:list={["mt-12 border-t pt-6", className]}>
+  {/* Meta line: edit link + last updated */}
+  {(editUrl || lastUpdated) && (
+    <div class="mb-6 flex flex-wrap items-center gap-4 text-sm text-muted-foreground">
+      {editUrl && (
+        <a href={editUrl} target="_blank" rel="noopener" class="inline-flex items-center gap-1 hover:text-foreground">
+          <svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M11 4H4a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2v-7"/><path d="M18.5 2.5a2.121 2.121 0 0 1 3 3L12 15l-4 1 1-4 9.5-9.5z"/></svg>
+          Edit this page
+        </a>
+      )}
+      {lastUpdated && <span>Last updated: {lastUpdated}</span>}
+    </div>
+  )}
+
+  {/* Prev / Next */}
+  {(prev || next) && (
+    <nav class="flex items-center justify-between gap-4" aria-label="Page navigation">
+      {prev ? (
+        <a href={prev.href} class="inline-flex items-center gap-2 rounded-md border px-4 py-2 text-sm font-medium transition-colors hover:bg-accent" rel="prev">
+          <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="15 18 9 12 15 6"/></svg>
+          <div class="text-left">
+            <div class="text-xs text-muted-foreground">Previous</div>
+            <div>{prev.label}</div>
+          </div>
+        </a>
+      ) : <div />}
+      {next ? (
+        <a href={next.href} class="inline-flex items-center gap-2 rounded-md border px-4 py-2 text-sm font-medium transition-colors hover:bg-accent" rel="next">
+          <div class="text-right">
+            <div class="text-xs text-muted-foreground">Next</div>
+            <div>{next.label}</div>
+          </div>
+          <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="9 18 15 12 9 6"/></svg>
+        </a>
+      ) : <div />}
+    </nav>
+  )}
+
+  {/* Footer meta — copyright + agent-friendly llms.txt link */}
+  {(copyright || llmsLink) && (
+    <div class="mt-6 flex flex-wrap items-center justify-between gap-2 border-t pt-4 text-xs text-muted-foreground">
+      {copyright ? <span><Fragment set:html={copyright} /></span> : <span />}
+      {llmsLink && (
+        <a
+          href={llmsLinkHref}
+          class="hover:text-foreground"
+          data-llms-link
+          aria-label="View this site as llms.txt for LLMs"
+        >
+          View as llms.txt
+        </a>
+      )}
+    </div>
+  )}
+</footer>

package/src/DocsHeader.astro

@@ -0,0 +1,41 @@
+---
+/**
+ * Standard docs site header.
+ * Sticky, frosted glass, with mobile menu toggle + dark mode + optional repo link.
+ */
+
+interface Props {
+  siteName: string;
+  siteUrl?: string;
+  repoUrl?: string;
+  class?: string;
+}
+
+const { siteName, siteUrl = "/", repoUrl, class: className } = Astro.props;
+---
+
+<header class:list={["sticky top-0 z-40 flex h-14 items-center gap-4 border-b bg-background/95 px-4 backdrop-blur-sm supports-[backdrop-filter]:bg-background/60", className]}>
+  <!-- Mobile menu button -->
+  <button data-docs-menu-toggle class="lg:hidden" aria-label="Toggle menu">
+    <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="4" y1="6" x2="20" y2="6"/><line x1="4" y1="12" x2="20" y2="12"/><line x1="4" y1="18" x2="20" y2="18"/></svg>
+  </button>
+
+  <a href={siteUrl} class="text-lg font-bold text-foreground no-underline">{siteName}</a>
+
+  <!-- Slot for additional header content (search, nav tabs, etc.) -->
+  <div class="ml-auto flex items-center gap-2">
+    <slot />
+
+    {repoUrl && (
+      <a href={repoUrl} target="_blank" rel="noopener" class="rounded-md p-2 text-muted-foreground hover:bg-accent hover:text-foreground" aria-label="Source repository">
+        <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="currentColor"><path d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z"/></svg>
+      </a>
+    )}
+
+    <!-- Dark mode toggle -->
+    <button data-docs-theme-toggle class="rounded-md p-2 text-muted-foreground hover:bg-accent hover:text-foreground" aria-label="Toggle dark mode">
+      <svg xmlns="http://www.w3.org/2000/svg" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="hidden dark:block"><circle cx="12" cy="12" r="5"/><line x1="12" y1="1" x2="12" y2="3"/><line x1="12" y1="21" x2="12" y2="23"/><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"/><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"/><line x1="1" y1="12" x2="3" y2="12"/><line x1="21" y1="12" x2="23" y2="12"/><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"/><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"/></svg>
+      <svg xmlns="http://www.w3.org/2000/svg" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="block dark:hidden"><path d="M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79z"/></svg>
+    </button>
+  </div>
+</header>