npm - @eqtylab/docs - Versions diffs - 0.3.0 → 0.3.1 - Mend

@eqtylab/docs 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (45) hide show

package/LICENSE +190 -0
package/README.md +52 -10
package/dist/config.js +1 -1
package/dist/index.js +16 -5
package/dist/index.js.map +1 -1
package/package.json +2 -2
package/dist/runtime/chrome/GlobalSearch.module.css +0 -26
package/dist/runtime/chrome/GlobalSearch.tsx +0 -422
package/dist/runtime/chrome/Header.astro +0 -105
package/dist/runtime/chrome/LinkIcon.astro +0 -35
package/dist/runtime/chrome/NavDrawer.astro +0 -60
package/dist/runtime/chrome/NavTree.astro +0 -112
package/dist/runtime/chrome/NotFoundBody.tsx +0 -12
package/dist/runtime/chrome/PageFooter.astro +0 -80
package/dist/runtime/chrome/Prose.astro +0 -169
package/dist/runtime/chrome/Sidebar.astro +0 -21
package/dist/runtime/chrome/TableOfContents.astro +0 -86
package/dist/runtime/chrome/ThemeToggle.tsx +0 -85
package/dist/runtime/chrome/TocElbow.astro +0 -30
package/dist/runtime/chrome/TocList.astro +0 -43
package/dist/runtime/components/AlertBridge.astro +0 -16
package/dist/runtime/components/CodeFence.astro +0 -38
package/dist/runtime/components/CodeFenceBridge.astro +0 -20
package/dist/runtime/components/Link.astro +0 -21
package/dist/runtime/components/TableBridge.astro +0 -18
package/dist/runtime/components/index.ts +0 -2
package/dist/runtime/layouts/DocsPage.astro +0 -50
package/dist/runtime/layouts/DocsShell.astro +0 -92
package/dist/runtime/lib/mdx-components.ts +0 -43
package/dist/runtime/lib/nav-data.ts +0 -74
package/dist/runtime/lib/summary.ts +0 -57
package/dist/runtime/lib/theme.ts +0 -84
package/dist/runtime/routes/docs-md.ts +0 -33
package/dist/runtime/routes/docs.astro +0 -92
package/dist/runtime/routes/llms-txt.ts +0 -38
package/dist/runtime/routes/not-found.astro +0 -16
package/dist/runtime/scripts/eq-copy.ts +0 -27
package/dist/runtime/scripts/eq-highlight.ts +0 -24
package/dist/runtime/scripts/eq-nav-drawer.ts +0 -31
package/dist/runtime/scripts/eq-nav-group.ts +0 -52
package/dist/runtime/scripts/eq-toc.ts +0 -166
package/dist/runtime/styles/chrome.css +0 -30
package/dist/runtime/styles/prose.css +0 -102
package/dist/runtime/styles/theme.css +0 -2
package/dist/runtime/styles/utilities.css +0 -38

package/dist/runtime/routes/not-found.astro DELETED Viewed

@@ -1,16 +0,0 @@
----
-import CONFIG from 'virtual:eqty-docs/config';
-import { withBase } from '@eqtylab/docs/paths';
-import DocsShell from '../layouts/DocsShell.astro';
-import Header from '../chrome/Header.astro';
-import NotFoundBody from '../chrome/NotFoundBody.tsx';
-const homeHref = withBase(CONFIG.pathPrefix ? `/${CONFIG.pathPrefix}/` : '/', {
-  base: import.meta.env.BASE_URL,
-});
----
-<DocsShell title="Page not found" noIndex>
-  <Header />
-  <NotFoundBody homeHref={homeHref} client:load />
-</DocsShell>

package/dist/runtime/scripts/eq-copy.ts DELETED Viewed

@@ -1,27 +0,0 @@
-/** Copy-to-clipboard for static code fences. One delegated listener, so it survives view transitions. */
-const COPIED_MS = 1600;
-function findFence(target: EventTarget | null): HTMLElement | null {
-  if (!(target instanceof Element)) return null;
-  return target.closest<HTMLElement>('[data-eq-copy]');
-}
-document.addEventListener('click', async (event) => {
-  const trigger = (event.target as Element | null)?.closest('button');
-  if (!trigger) return;
-  const fence = findFence(trigger);
-  if (!fence) return;
-  const code = fence.dataset.eqCopy;
-  if (!code) return;
-  event.preventDefault();
-  try {
-    await navigator.clipboard.writeText(code);
-    fence.setAttribute('data-copied', '');
-    window.setTimeout(() => fence.removeAttribute('data-copied'), COPIED_MS);
-  } catch {
-    // Clipboard denied; do not show a success state.
-  }
-});

package/dist/runtime/scripts/eq-highlight.ts DELETED Viewed

@@ -1,24 +0,0 @@
-/**
- * Starts highlighting for server-rendered code blocks, whose `useEffect` never
- * runs without hydration. A custom element so it survives view transitions.
- */
-import { scheduleHighlight } from '@eqtylab/equality';
-class EqHighlight extends HTMLElement {
-  // Captured on connect: a detached element no longer knows its tree, and the rescan on removal drops stale ranges.
-  #root?: Node;
-  connectedCallback() {
-    this.#root = this.getRootNode();
-    void scheduleHighlight(this.#root);
-  }
-  disconnectedCallback() {
-    void scheduleHighlight(this.#root);
-    this.#root = undefined;
-  }
-}
-if (!customElements.get('eq-highlight')) {
-  customElements.define('eq-highlight', EqHighlight);
-}

package/dist/runtime/scripts/eq-nav-drawer.ts DELETED Viewed

@@ -1,31 +0,0 @@
-/**
- * With no script the Popover API opens and closes the drawer, shuts it on Escape or a
- * click outside, and paints it above everything else. Two things it does not give,
- * both verified in the browser suite rather than assumed:
- *
- * 1. `aria-expanded` on the invoker. No engine adds it, so a screen reader hears a
- *    button with no disclosure state.
- * 2. Focus return on dismiss in WebKit. Chromium restores focus to the invoker;
- *    desktop Safari, mobile Safari and iPad all leave it on `<body>`, which strands a
- *    keyboard user exactly the way `DialogContainer` does. See equality-dialog-repair.
- *
- * Both are reflected off the `toggle` event so they track every dismissal path,
- * rather than being set once and going stale.
- */
-const drawer = document.getElementById('eq-nav-drawer');
-const trigger = document.querySelector<HTMLElement>('[popovertarget="eq-nav-drawer"]');
-if (drawer && trigger) {
-  trigger.setAttribute('aria-expanded', 'false');
-  drawer.addEventListener('toggle', (event) => {
-    const open = (event as ToggleEvent).newState === 'open';
-    trigger.setAttribute('aria-expanded', String(open));
-    // Only when the engine left focus nowhere. Clicking a link inside the drawer
-    // navigates away, and light-dismissing onto another control should keep it.
-    if (!open && document.activeElement === document.body) {
-      trigger.focus();
-    }
-  });
-}

package/dist/runtime/scripts/eq-nav-group.ts DELETED Viewed

@@ -1,52 +0,0 @@
-/**
- * Animates a navigation group open and closed, on top of `<details>`.
- *
- * Do not swap this for Equality's `MotionCollapsibleContent`. It measures after mount
- * and animates up from zero, so a group that starts open expands on every page load.
- *
- * Duration and easing are that component's, so the motion still matches.
- */
-const DURATION = 300;
-const EASING = 'ease-in-out';
-function wire(group: HTMLDetailsElement) {
-  const summary = group.querySelector('summary');
-  const panel = summary?.nextElementSibling;
-  if (!summary || !(panel instanceof HTMLElement)) return;
-  let running: Animation | null = null;
-  summary.addEventListener('click', (event) => {
-    if (window.matchMedia('(prefers-reduced-motion: reduce)').matches) return;
-    // The browser would toggle `open` immediately; the close has to outlive that.
-    event.preventDefault();
-    running?.cancel();
-    const opening = !group.open;
-    // Measured while open in both directions, so interrupting mid-animation does not
-    // snap to a stale height.
-    if (opening) group.open = true;
-    const height = panel.scrollHeight;
-    const from = opening ? 0 : panel.getBoundingClientRect().height;
-    panel.style.overflow = 'hidden';
-    running = panel.animate(
-      {
-        height: [`${from}px`, `${opening ? height : 0}px`],
-        opacity: [opening ? 0 : 1, opening ? 1 : 0],
-      },
-      { duration: DURATION, easing: EASING }
-    );
-    running.onfinish = () => {
-      running = null;
-      panel.style.removeProperty('overflow');
-      if (!opening) group.open = false;
-    };
-  });
-}
-for (const group of document.querySelectorAll<HTMLDetailsElement>('details[data-eq-nav-group]')) {
-  wire(group);
-}

package/dist/runtime/scripts/eq-toc.ts DELETED Viewed

@@ -1,166 +0,0 @@
-/**
- * Scroll-spy for the table of contents, and the lit segment of its rail.
- *
- * Do not swap this for an IntersectionObserver band. A band leaves nothing active at
- * load, and nothing between two headings.
- *
- * The segment is a dash on a path tracing the whole rail, elbows included, so it
- * travels through corners. Its numbers are path length, not pixels.
- */
-/** Scaling by distance is what makes a corner take visible time. */
-const MS_PER_PX = 8;
-const MIN_MS = 220;
-const MAX_MS = 520;
-const EASE = 'cubic-bezier(0.4, 0, 0.2, 1)';
-interface Span {
-  start: number;
-  length: number;
-}
-function measureRail(root: HTMLElement, path: SVGPathElement) {
-  const origin = root.getBoundingClientRect();
-  const spans = new Map<string, Span>();
-  const parts: string[] = [];
-  let cursor = 0;
-  const rows = root.querySelectorAll<HTMLElement>('a[data-slug], [data-eq-elbow]');
-  for (const row of rows) {
-    const box = row.getBoundingClientRect();
-    const top = box.top - origin.top;
-    const bottom = box.bottom - origin.top;
-    const direction = row.getAttribute('data-eq-elbow');
-    if (direction) {
-      const left = box.left - origin.left;
-      const right = box.right - origin.left;
-      const [from, to] = direction === 'in' ? [left, right] : [right, left];
-      const mid = (top + bottom) / 2;
-      if (parts.length === 0) parts.push(`M ${from} ${top}`);
-      parts.push(`C ${from} ${mid}, ${to} ${mid}, ${to} ${bottom}`);
-    } else {
-      // The border's centre line, so the lit segment covers the grey one exactly.
-      const x = box.left - origin.left + parseFloat(getComputedStyle(row).borderLeftWidth) / 2;
-      if (parts.length === 0) parts.push(`M ${x} ${top}`);
-      parts.push(`L ${x} ${bottom}`);
-    }
-    path.setAttribute('d', parts.join(' '));
-    const end = path.getTotalLength();
-    const slug = row.dataset.slug;
-    if (!direction && slug) spans.set(slug, { start: cursor, length: end - cursor });
-    cursor = end;
-  }
-  return { spans, total: cursor };
-}
-class EqToc extends HTMLElement {
-  #teardown?: () => void;
-  connectedCallback() {
-    const slugs = (this.dataset.slugs ?? '').split(',').filter(Boolean);
-    const links = new Map<string, HTMLAnchorElement>();
-    for (const link of this.querySelectorAll<HTMLAnchorElement>('a[data-slug]')) {
-      if (link.dataset.slug) links.set(link.dataset.slug, link);
-    }
-    const targets = slugs
-      .map((slug) => document.getElementById(slug))
-      .filter((el): el is HTMLElement => el !== null);
-    if (targets.length === 0) return;
-    const path = this.querySelector<SVGPathElement>('[data-eq-toc-rail]');
-    const rails = this.querySelector<HTMLElement>('[data-eq-toc-rails]');
-    const still = window.matchMedia('(prefers-reduced-motion: reduce)');
-    let spans = new Map<string, Span>();
-    let total = 0;
-    let previous: number | null = null;
-    const remeasure = () => {
-      if (!path || !rails) return;
-      previous = null;
-      ({ spans, total } = measureRail(rails, path));
-    };
-    const light = (slug: string) => {
-      if (!path) return;
-      const span = spans.get(slug);
-      if (!span) return;
-      if (previous === null || still.matches) {
-        // No slide into the first position, and none under reduced motion.
-        path.style.transition = 'none';
-      } else {
-        const ms = Math.min(
-          MAX_MS,
-          Math.max(MIN_MS, Math.round(Math.abs(span.start - previous) * MS_PER_PX))
-        );
-        path.style.transition = `stroke-dasharray ${ms}ms ${EASE}, stroke-dashoffset ${ms}ms ${EASE}`;
-      }
-      path.style.strokeDasharray = `${span.length} ${total}`;
-      path.style.strokeDashoffset = `${-span.start}`;
-      if (previous === null) {
-        // Commit the jump before the fade, so the segment appears in place.
-        void path.getBoundingClientRect();
-        path.style.opacity = '1';
-      }
-      previous = span.start;
-    };
-    let frame = 0;
-    const paint = () => {
-      frame = 0;
-      // Clicking a heading lands it 96px down (scroll-mt-24), so the line sits below.
-      const line = window.innerHeight * 0.2;
-      let active = targets[0];
-      for (const target of targets) {
-        if (target.getBoundingClientRect().top <= line) active = target;
-        else break;
-      }
-      for (const [slug, link] of links) {
-        if (slug === active.id) {
-          link.setAttribute('data-active', '');
-          // `location` is the ARIA value for the current place within a set.
-          link.setAttribute('aria-current', 'location');
-        } else {
-          link.removeAttribute('data-active');
-          link.removeAttribute('aria-current');
-        }
-      }
-      light(active.id);
-    };
-    const schedule = () => {
-      if (frame === 0) frame = requestAnimationFrame(paint);
-    };
-    const onResize = () => {
-      remeasure();
-      schedule();
-    };
-    window.addEventListener('scroll', schedule, { passive: true });
-    window.addEventListener('resize', onResize, { passive: true });
-    remeasure();
-    paint();
-    this.#teardown = () => {
-      window.removeEventListener('scroll', schedule);
-      window.removeEventListener('resize', onResize);
-      if (frame !== 0) cancelAnimationFrame(frame);
-    };
-  }
-  disconnectedCallback() {
-    this.#teardown?.();
-    this.#teardown = undefined;
-  }
-}
-if (!customElements.get('eq-toc')) {
-  customElements.define('eq-toc', EqToc);
-}

package/dist/runtime/styles/chrome.css DELETED Viewed

@@ -1,30 +0,0 @@
-/* Shared geometry and the variants the chrome needs; component styling is inline
- * Tailwind in the markup. */
-@reference './theme.css';
-/* The mirror of Equality's own `dark` variant. Needed because the logo and the header
- * link marks ship white, so light is the theme that has to invert them. */
-@custom-variant light (&:where(html[data-equality-theme=light], html[data-equality-theme=light] *));
-/* Equality's hover fires on `:focus` rather than `:focus-visible`, so a mouse click
- * leaves a control filled as if it were the current page. This undoes it for pointer
- * focus only, leaving the keyboard ring intact. */
-@custom-variant pointer-focus (&:focus:not(:focus-visible));
-:root {
-  --eq-docs-header-height: 4.3125rem;
-  --eq-docs-sidebar-width: 18rem;
-  --eq-docs-toc-width: 15rem;
-  --eq-docs-content-max: 48rem;
-  /* eqtylab.io's display-text fade, on tokens so light gets the inverse for free.
-   * Used by the header label and the page title. */
-  --eq-docs-display-gradient: linear-gradient(
-    135deg,
-    var(--color-text-primary),
-    var(--color-background) 175%
-  );
-}
-body {
-  @apply bg-background text-text-primary;
-}

package/dist/runtime/styles/prose.css DELETED Viewed

@@ -1,102 +0,0 @@
-/*
- * Docs typography.
- *
- * Only what the page itself wrote is styled, marked `data-eq-md` by `rehypeProseScope`.
- * Drop that guard and every component's children get typeset as body copy.
- *
- * Both guards sit inside :where(), so a consumer can override without !important.
- */
-@reference './theme.css';
-.eq-prose {
-  & > :first-child {
-    @apply mt-0;
-  }
-  & > :last-child {
-    @apply mb-0;
-  }
-  & :where([data-eq-md]):not(:where([data-eq-chrome], [data-eq-chrome] *)) {
-    &:is(h1, h2, h3, h4, h5, h6) {
-      @apply scroll-mt-24;
-    }
-    &:is(h1) {
-      @apply mb-3 mt-12 text-4xl font-bold;
-      & > code {
-        @apply text-3xl;
-      }
-    }
-    &:is(h2) {
-      @apply mb-3 mt-12 text-2xl font-semibold;
-      & > code {
-        @apply text-xl;
-      }
-    }
-    &:is(h3) {
-      @apply mb-3 mt-8 text-xl font-medium;
-      & > code {
-        @apply text-lg;
-      }
-    }
-    &:is(h4) {
-      @apply mb-3 mt-6 text-lg font-medium;
-      & > code {
-        @apply text-base;
-      }
-    }
-    &:is(h5) {
-      @apply mb-3 mt-6 text-base font-medium;
-      & > code {
-        @apply text-sm;
-      }
-    }
-    &:is(h6) {
-      @apply mb-3 mt-6 text-sm font-medium;
-      & > code {
-        @apply text-xs;
-      }
-    }
-    /* 16px, which has to stay wider than the 28px line height inside a paragraph,
-     * or consecutive blocks read as one. */
-    &:is(p) {
-      @apply text-text-secondary mb-4 text-base/7 font-normal;
-    }
-    :is(p, li) &:is(b, strong) {
-      @apply text-text-primary font-medium;
-    }
-    &:is(ul, ol) {
-      @apply text-text-secondary mb-4 pl-4;
-      /* Never `space-y-*` here: it unbalances against the `:not(:where(...))` above
-       * and compiles to a rule the browser throws away, leaving items unspaced. */
-      & > li + li {
-        @apply mt-2;
-      }
-    }
-    &:is(ul) {
-      @apply list-disc;
-    }
-    &:is(ol) {
-      @apply list-decimal;
-    }
-    &:is(a) {
-      @apply text-text-primary hover:text-lilac-400 font-medium underline underline-offset-4 transition-all;
-    }
-    /* Inline code, but never the contents of a highlighted block. */
-    :not(pre) > &:is(code) {
-      @apply dark:bg-background-overlay bg-greyscale-200 text-text-secondary rounded-sm p-1 text-sm;
-    }
-    /* No table rules: markdown tables render through Equality's Table. */
-    &:is(hr) {
-      @apply border-border mb-4;
-    }
-  }
-}

package/dist/runtime/styles/theme.css DELETED Viewed

	@@ -1,2 +0,0 @@
1	- /* @reference target for every .module.css here, so the bare specifier resolves from this package's node_modules. /
2	- @import '@eqtylab/equality/theme-config.css';

package/dist/runtime/styles/utilities.css DELETED Viewed

@@ -1,38 +0,0 @@
-/*
- * Class recipes shared by more than one piece of chrome. Real utilities, so the markup
- * stays inline everywhere else and the recipe still has one definition.
- */
-@reference './theme.css';
-/**
- * The header bar's control geometry, shared so the links and the theme toggle cannot
- * drift apart. `display` is deliberately absent: the links are flex rows and the theme
- * toggle is a one-cell grid, and a display utility in here would collide with theirs.
- */
-@utility eq-nav-control {
-  @apply text-text-secondary hover:text-text-primary hover:bg-background;
-  @apply h-10 items-center gap-1.5 rounded-md px-3;
-  @apply text-sm font-medium no-underline transition-colors;
-}
-/**
- * eqtylab.io's display-text fade, used by the header label and the page title.
- *
- * Callers add their own `forced-colors:text-*`: the header label inherits, the page
- * title names a token, so the solid colour cannot live in here.
- */
-@utility eq-display-gradient {
-  @apply bg-[image:var(--eq-docs-display-gradient)] bg-clip-text text-transparent;
-  /* Clipping the gradient to the text crops descenders without this. */
-  @apply py-[0.05em];
-  -webkit-background-clip: text;
-  -webkit-text-fill-color: transparent;
-  /* Windows High Contrast and similar modes drop the gradient but keep the transparent
-   * fill, so the text would vanish. This puts the paint back; the caller supplies the
-   * colour. */
-  @media (forced-colors: active) {
-    background-image: none;
-    -webkit-text-fill-color: currentColor;
-  }
-}