lildocs 0.1.21 → 0.1.23

package/dist/render/Search.tsrx

@@ -1,414 +0,0 @@
-import { useEffect, useMemo, useRef, useState } from "octane";
-import { queueSectionHighlight } from "./section-highlight.js";
-
-export type SearchEntry = {
-  kind: "page" | "section";
-  route: string;
-  title: string;
-  pageTitle: string;
-  headings: string[];
-  text: string;
-  excerpt: string;
-  depth?: number;
-};
-
-type SearchMatch = {
-  entry: SearchEntry;
-  title: string;
-  subtitle: string;
-  score: number;
-  terms: string[];
-  type: "title" | "body";
-};
-
-export function SearchBox({
-  anchorElement,
-  index,
-  siteRoot,
-  preloadedUrls,
-  issueUrl,
-}: {
-  anchorElement: Element;
-  index: SearchEntry[];
-  siteRoot: URL;
-  preloadedUrls: Set<string>;
-  issueUrl?: string;
-}) @{
-  const inputRef = useRef<HTMLInputElement | null>(null);
-  const selectedRef = useRef<HTMLAnchorElement | null>(null);
-  const [query, setQuery] = useState("");
-  const [open, setOpen] = useState(false);
-  const [selectedIndex, setSelectedIndex] = useState(-1);
-  const matches = useMemo(() => searchIndex(index, query), [index, query]);
-
-  useEffect(() => {
-    selectedRef.current?.scrollIntoView({ block: "nearest" });
-    preloadRelativeUrl(
-      selectedRef.current?.getAttribute("href"),
-      preloadedUrls,
-    );
-  }, [matches, preloadedUrls, selectedIndex]);
-
-  useEffect(() => {
-    const closeOnOutsidePointer = (event: PointerEvent) => {
-      if (
-        event.target instanceof Node && !anchorElement.contains(event.target)
-      ) {
-        setOpen(false);
-      }
-    };
-    document.addEventListener("pointerdown", closeOnOutsidePointer);
-    return () => document.removeEventListener(
-      "pointerdown",
-      closeOnOutsidePointer,
-    );
-  }, [anchorElement]);
-
-  useEffect(() => {
-    const toggleSearch = () => {
-      if (document.activeElement === inputRef.current) {
-        inputRef.current?.blur();
-        setOpen(false);
-        return;
-      }
-
-      document.documentElement.classList.remove("sidebar-collapsed");
-      document.dispatchEvent(new CustomEvent("lildocs:sidebar-menu-open"));
-      inputRef.current?.focus();
-      setOpen(Boolean(query.trim()));
-    };
-    const handleShortcut = (event: KeyboardEvent) => {
-      const key = event.key.toLowerCase();
-      const hasCommandModifier = event.metaKey || event.ctrlKey;
-      if (
-        hasCommandModifier && (key === "k" || event.shiftKey && key === "f")
-      ) {
-        event.preventDefault();
-        toggleSearch();
-      }
-    };
-
-    document.addEventListener("lildocs:search-toggle", toggleSearch);
-    document.addEventListener("keydown", handleShortcut);
-    return () => {
-      document.removeEventListener("lildocs:search-toggle", toggleSearch);
-      document.removeEventListener("keydown", handleShortcut);
-    };
-  }, [query]);
-
-  const clearSearch = () => {
-    setQuery("");
-    setSelectedIndex(-1);
-    setOpen(false);
-  };
-
-  const selectResult = (nextIndex: number) => {
-    if (matches.length === 0) {
-      setSelectedIndex(-1);
-      return;
-    }
-
-    setSelectedIndex((nextIndex + matches.length) % matches.length);
-  };
-
-  <>
-    <span class="searchIcon ti ti-search" aria-hidden="true" />
-    <input
-      ref={inputRef}
-      id="lildocs-search-input"
-      type="search"
-      placeholder="Search docs"
-      aria-label="Search docs"
-      aria-expanded={open}
-      aria-controls="lildocs-search-results"
-      value={query}
-      onInput={(event) => {
-        const nextQuery = (event.currentTarget as HTMLInputElement).value;
-        setQuery(nextQuery);
-        setSelectedIndex(nextQuery.trim() ? 0 : -1);
-        setOpen(Boolean(nextQuery.trim()));
-      }}
-      onFocus={() => {
-        if (query.trim()) {
-          setOpen(true);
-        }
-      }}
-      onKeyDown={(event) => {
-        if (!open || matches.length === 0) {
-          return;
-        }
-
-        if (event.key === "ArrowDown") {
-          event.preventDefault();
-          selectResult(selectedIndex + 1);
-          return;
-        }
-
-        if (event.key === "ArrowUp") {
-          event.preventDefault();
-          selectResult(selectedIndex - 1);
-          return;
-        }
-
-        if (event.key === "Enter") {
-          event.preventDefault();
-          const selected = selectedRef.current;
-          if (selected) {
-            preloadRelativeUrl(selected.getAttribute("href"), preloadedUrls);
-            selected.click();
-          }
-          return;
-        }
-
-        if (event.key === "Escape") {
-          setOpen(false);
-        }
-      }}
-    />
-    @if (open) {
-      <div id="lildocs-search-results" class="searchResults" aria-live="polite">
-        <div class="searchResultsContent">
-          <header class="searchResultsHeader">
-            <p class="searchResultsEyebrow">Search</p>
-            <h2>
-              Results for
-              <span>
-                {query as string}
-              </span>
-            </h2>
-            <p class="searchResultsSummary">
-              {matches.length}
-
-              {matches.length === 1 ? "result" : "results"}
-            </p>
-          </header>
-          @if (matches.length === 0) {
-            <section class="searchEmpty">
-              <p>No pages match this search.</p>
-              @if (issueUrl) {
-                <a href={issueUrlForQuery(issueUrl, query)}>
-                  Create a GitHub issue
-                </a>
-              }
-            </section>
-          } @else {
-            <div class="searchResultList" role="listbox">
-              @for (const match of matches; index matchIndex; key `${match.entry.route}:${match.title}`) {
-                const selected = matchIndex === selectedIndex;
-                const resultUrl = new URL(match.entry.route, siteRoot).href;
-                <a
-                  ref={selected ? selectedRef : undefined}
-                  href={resultUrl}
-                  data-search-result="true"
-                  class={`searchResult${selected ? " selected" : ""}`}
-                  role="option"
-                  aria-selected={selected}
-                  onMouseOver={() => setSelectedIndex(matchIndex)}
-                  onClick={() => {
-                    if (match.entry.kind === "section") {
-                      queueSectionHighlight(resultUrl);
-                    }
-                    clearSearch();
-                  }}
-                >
-                  <span class="searchResultType">
-                    {match.entry.kind === "page" ? "Page" : "Section"}
-                  </span>
-                  <span class="searchResultTitle">{renderHighlighted(
-                    match.title,
-                    match.terms,
-                  )}</span>
-                  <span class="searchResultSnippet">{renderHighlighted(
-                    match.subtitle,
-                    match.terms,
-                  )}</span>
-                </a>
-              }
-            </div>
-          }
-        </div>
-      </div>
-    }
-  </>
-}
-
-function issueUrlForQuery(issueUrl: string, query: string) {
-  const url = new URL(issueUrl);
-  const trimmedQuery = query.trim();
-  if (trimmedQuery) {
-    url.searchParams.set("title", `Missing docs for ${trimmedQuery}`);
-    url.searchParams.set(
-      "body",
-      `I searched the docs for "${trimmedQuery}" but did not find a result.`,
-    );
-  }
-
-  return url.href;
-}
-
-function searchIndex(index: SearchEntry[], query: string) {
-  const normalizedQuery = normalizeQuery(query);
-  if (!normalizedQuery) {
-    return [];
-  }
-
-  const terms = normalizedQuery.split(/\s+/);
-  const matches = index.map(
-    (entry) => matchEntry(entry, terms, normalizedQuery),
-  ).filter((match) => match !== undefined);
-  const titleMatches = matches.filter((match) => match.type === "title");
-  const sectionBodyMatches = matches.filter(
-    (match) => match.type === "body" && match.entry.kind === "section",
-  );
-  const bodyMatches =
-    sectionBodyMatches.length > 0
-      ? sectionBodyMatches
-      : matches.filter((match) => match.type === "body");
-  const visibleMatches =
-    titleMatches.length < 4 ? [...titleMatches, ...bodyMatches] : titleMatches;
-
-  return visibleMatches.toSorted(
-    (a, b) => b.score - a.score || a.title.localeCompare(b.title),
-  ).slice(0, 8);
-}
-
-export function preloadRelativeUrl(
-  href: string | null | undefined,
-  preloadedUrls: Set<string>,
-) {
-  if (!href || href.startsWith("mailto:") || href.startsWith("#")) {
-    return;
-  }
-
-  const url = new URL(href, document.baseURI);
-  if (url.origin !== window.location.origin || preloadedUrls.has(url.href)) {
-    return;
-  }
-
-  preloadedUrls.add(url.href);
-  const preload = document.createElement("link");
-  preload.rel = "prefetch";
-  preload.href = url.href;
-  document.head.append(preload);
-}
-
-function matchEntry(
-  entry: SearchEntry,
-  terms: string[],
-  normalizedQuery: string,
-): SearchMatch | undefined {
-  const titleScore = scoreText(entry.title, terms, normalizedQuery);
-  if (titleScore > 0) {
-    return {
-      entry,
-      title: entry.title,
-      subtitle: subtitleForEntry(entry),
-      score: (entry.kind === "page" ? 300 : 250) + titleScore,
-      terms,
-      type: "title",
-    };
-  }
-
-  const bodyScore = scoreText(entry.text, terms, normalizedQuery);
-  if (bodyScore > 0) {
-    return {
-      entry,
-      title: matchingSnippet(entry.excerpt, terms),
-      subtitle: subtitleForEntry(entry),
-      score: 20 + bodyScore,
-      terms,
-      type: "body",
-    };
-  }
-
-  return undefined;
-}
-
-function scoreText(value: string, terms: string[], normalizedQuery: string) {
-  const text = value.toLowerCase();
-  if (!text) {
-    return 0;
-  }
-
-  let score = 0;
-  if (text === normalizedQuery) {
-    score += 80;
-  } else if (text.includes(normalizedQuery)) {
-    score += 40;
-  }
-
-  for (const term of terms) {
-    if (text.includes(term)) {
-      score += 10;
-    }
-  }
-
-  return score;
-}
-
-function subtitleForEntry(entry: SearchEntry) {
-  if (entry.kind === "page") {
-    return entry.headings.slice(0, 3).join(" / ") || "Page";
-  }
-
-  const parents = entry.headings.slice(0, -1);
-  return uniqueParts([entry.pageTitle, ...parents]).join(" / ");
-}
-
-function matchingSnippet(text: string, terms: string[]) {
-  const paragraphs = text.split(/\n{2,}/).map(normalizeSnippetPart).filter(
-    Boolean,
-  );
-  const paragraph =
-    paragraphs.find((part) => containsTerms(part, terms)) ?? paragraphs[0] ??
-      "";
-  const sentences =
-    paragraph.match(/[^.!?]+(?:[.!?]+|$)/g)?.map(normalizeSnippetPart) ?? [];
-
-  return sentences.find((sentence) => containsTerms(sentence, terms)) ??
-    paragraph;
-}
-
-function containsTerms(value: string, terms: string[]) {
-  const normalized = value.toLocaleLowerCase();
-  return terms.every((term) => normalized.includes(term));
-}
-
-function normalizeSnippetPart(value: string) {
-  return value.replace(/\s+/g, " ").trim();
-}
-
-function renderHighlighted(value: string, terms: string[]) {
-  const matchingTerms = terms.filter(Boolean).toSorted(
-    (a, b) => b.length - a.length,
-  );
-  if (matchingTerms.length === 0) {
-    return value;
-  }
-
-  const pattern = new RegExp(`(${matchingTerms.map(escapeRegExp).join(
-    "|",
-  )})`, "gi");
-  return value.split(pattern).map(
-    (part) => matchingTerms.some((term) => part.toLowerCase() === term)
-      ? <mark>
-          {part as string}
-        </mark>
-      : (part),
-  );
-}
-
-function normalizeQuery(value: string) {
-  return value.replace(/[^\p{L}\p{N}]+/gu, " ").replace(
-    /\s+/g,
-    " ",
-  ).trim().toLowerCase();
-}
-
-function uniqueParts(parts: string[]) {
-  return parts.filter((part, index) => part && parts.indexOf(part) === index);
-}
-
-function escapeRegExp(value: string) {
-  return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-}

package/dist/render/client.tsrx

@@ -1,52 +0,0 @@
-import { createRoot } from "octane";
-import { initCopyCode } from "./copy-code.js";
-import { initHeadingLinks } from "./heading-links.js";
-import { initNavigation } from "./navigation.js";
-import { preloadRelativeUrl, SearchBox } from "./Search.tsrx";
-import { initSectionHighlights } from "./section-highlight.js";
-import { initSidebar } from "./sidebar.js";
-import { initTableViewer } from "./table-viewer.js";
-import { initTocVisibility } from "./toc-visibility.js";
-import type { SearchEntry } from "./Search.tsrx";
-
-initCopyCode();
-initHeadingLinks();
-initNavigation();
-initSectionHighlights();
-initSidebar();
-initTableViewer();
-initTocVisibility();
-
-void mountSearch();
-
-async function mountSearch() {
-  const root = document.querySelector("#lildocs-search-root");
-  if (!root) {
-    return;
-  }
-
-  const embeddedIndex = document.querySelector("#lildocs-search-index");
-  const base = new URL(window.lildocsSearchUrl ||
-    "search-index.json", document.baseURI);
-  const index = embeddedIndex?.textContent
-    ? JSON.parse(embeddedIndex.textContent) as SearchEntry[]
-    : await fetch(base).then((response) => response.json()) as SearchEntry[];
-  const siteRoot = new URL(".", base);
-  const preloadedUrls = new Set<string>();
-
-  document.addEventListener("mouseover", (event) => {
-    const link = (event.target as Element | null)?.closest?.("a[href]");
-    if (!link) {
-      return;
-    }
-    preloadRelativeUrl(link.getAttribute("href"), preloadedUrls);
-  });
-
-  createRoot(root).render(SearchBox, {
-    anchorElement: root,
-    index,
-    siteRoot,
-    preloadedUrls,
-    issueUrl: window.lildocsIssueUrl,
-  });
-}

package/dist/render/copy-code.ts

@@ -1,56 +0,0 @@
-const icons = {
-  copy: '<span class="ti ti-copy copyCodeIcon" aria-hidden="true"></span>',
-  check:
-    '<span class="ti ti-copy-check copyCodeIcon" aria-hidden="true"></span>',
-  error:
-    '<span class="ti ti-alert-circle copyCodeIcon" aria-hidden="true"></span>',
-};
-
-export function initCopyCode() {
-  enhanceCodeBlocks();
-  document.addEventListener("lildocs:page-view", enhanceCodeBlocks);
-}
-
-function enhanceCodeBlocks() {
-  const blocks = document.querySelectorAll(".content article pre");
-  if (!blocks.length || !navigator.clipboard?.writeText) {
-    return;
-  }
-
-  for (const block of Array.from(blocks)) {
-    if (block.parentElement?.classList.contains("copyCodeBlock")) {
-      continue;
-    }
-
-    const copyText = block.textContent ?? "";
-    const wrapper = document.createElement("div");
-    wrapper.className = "copyCodeBlock";
-    const button = document.createElement("button");
-    button.type = "button";
-    button.className = "copyCodeButton";
-    button.setAttribute("aria-label", "Copy code");
-    button.title = "Copy code";
-    button.innerHTML = icons.copy;
-
-    button.addEventListener("click", async () => {
-      try {
-        await navigator.clipboard.writeText(copyText);
-        button.innerHTML = icons.check;
-        button.setAttribute("aria-label", "Copied");
-        button.title = "Copied";
-        window.setTimeout(() => {
-          button.innerHTML = icons.copy;
-          button.setAttribute("aria-label", "Copy code");
-          button.title = "Copy code";
-        }, 1600);
-      } catch {
-        button.innerHTML = icons.error;
-        button.setAttribute("aria-label", "Copy failed");
-        button.title = "Copy failed";
-      }
-    });
-
-    block.before(wrapper);
-    wrapper.append(block, button);
-  }
-}

package/dist/render/heading-links.ts

@@ -1,85 +0,0 @@
-const headingSelector =
-  ".content article h1[id], .content article h2[id], .content article h3[id], .content article h4[id], .content article h5[id], .content article h6[id]";
-const headingLinkIcons = {
-  link: '<span class="ti ti-link" aria-hidden="true"></span>',
-  check: '<span class="ti ti-check" aria-hidden="true"></span>',
-};
-
-export function initHeadingLinks() {
-  enhanceHeadingLinks();
-  document.addEventListener("lildocs:page-view", enhanceHeadingLinks);
-  document.addEventListener("click", (event) => {
-    if (!(event.target instanceof Element) || event.target.closest("a")) {
-      return;
-    }
-
-    const heading = event.target.closest<HTMLHeadingElement>(headingSelector);
-    if (!heading) {
-      return;
-    }
-
-    void copyHeadingLink(heading);
-  });
-}
-
-function enhanceHeadingLinks() {
-  const headings =
-    document.querySelectorAll<HTMLHeadingElement>(headingSelector);
-
-  for (const heading of Array.from(headings)) {
-    if (heading.querySelector(".headingLinkIcon")) {
-      continue;
-    }
-
-    const icon = document.createElement("button");
-    icon.type = "button";
-    icon.className = "headingLinkIcon";
-    icon.setAttribute("aria-label", "Copy link to heading");
-    icon.title = "Copy link to heading";
-    icon.innerHTML = headingLinkIcons.link;
-    heading.append(icon);
-  }
-}
-
-async function copyHeadingLink(heading: HTMLHeadingElement) {
-  const url = new URL(window.location.href);
-  url.hash = heading.tagName === "H1" ? "" : heading.id;
-
-  try {
-    await writeClipboard(url.href);
-    const icon = heading.querySelector<HTMLButtonElement>(".headingLinkIcon");
-    if (!icon) {
-      return;
-    }
-
-    icon.classList.add("headingLinkCopied");
-    icon.innerHTML = headingLinkIcons.check;
-    icon.setAttribute("aria-label", "Copied");
-    icon.title = "Copied";
-    window.setTimeout(() => {
-      icon.classList.remove("headingLinkCopied");
-      icon.innerHTML = headingLinkIcons.link;
-      icon.setAttribute("aria-label", "Copy link to heading");
-      icon.title = "Copy link to heading";
-    }, 1600);
-  } catch {}
-}
-
-async function writeClipboard(value: string) {
-  if (navigator.clipboard?.writeText) {
-    await navigator.clipboard.writeText(value);
-    return;
-  }
-
-  const textarea = document.createElement("textarea");
-  textarea.value = value;
-  textarea.style.position = "fixed";
-  textarea.style.opacity = "0";
-  document.body.append(textarea);
-  textarea.select();
-  const copied = document.execCommand("copy");
-  textarea.remove();
-  if (!copied) {
-    throw new Error("Unable to copy heading link");
-  }
-}

package/dist/render/navigation.ts

@@ -1,16 +0,0 @@
-import Swup from "swup";
-
-export function initNavigation() {
-  if (window.location.protocol === "file:") {
-    return;
-  }
-
-  const swup = new Swup({
-    containers: ["#swup", "#lildocs-sidebar-navigation"],
-    animationSelector: '[class*="transition-"]',
-  });
-
-  swup.hooks.on("page:view", () => {
-    document.dispatchEvent(new CustomEvent("lildocs:page-view"));
-  });
-}

package/dist/render/paths.ts

@@ -1,47 +0,0 @@
-function routeDir(route: string) {
-  const index = route.lastIndexOf("/");
-  return index === -1 ? "." : route.slice(0, index);
-}
-
-function normalizeRoute(route: string) {
-  const parts: string[] = [];
-  for (const part of route.split("/")) {
-    if (!part || part === ".") {
-      continue;
-    }
-
-    if (part === "..") {
-      parts.pop();
-    } else {
-      parts.push(part);
-    }
-  }
-
-  return parts.join("/");
-}
-
-export function relativeUrl(fromRoute: string, toRoute: string) {
-  const fromParts =
-    routeDir(fromRoute) === "." ? [] : routeDir(fromRoute).split("/");
-  const toParts = normalizeRoute(toRoute).split("/");
-  while (
-    fromParts.length > 0 &&
-    toParts.length > 0 &&
-    fromParts[0] === toParts[0]
-  ) {
-    fromParts.shift();
-    toParts.shift();
-  }
-
-  const relativeParts = [...fromParts.map(() => ".."), ...toParts];
-  const relative = relativeParts.join("/");
-  return relative.startsWith(".") ? relative : `./${relative}`;
-}
-
-export function rootRelativeUrl(route: string, target: string) {
-  const dir = routeDir(route);
-  const depth = dir === "." ? 0 : dir.split("/").length;
-  const prefix =
-    depth === 0 ? "." : Array.from({ length: depth }, () => "..").join("/");
-  return `${prefix}/${target}`;
-}

package/dist/render/renderPage.tsrx

@@ -1,14 +0,0 @@
-import { renderToStaticMarkup } from "octane/server";
-import type { RenderPageProps } from "../core/frontend.js";
-import { Layout } from "./Layout.tsrx";
-
-export function renderPage(props: RenderPageProps) {
-  const { html, css } = renderToStaticMarkup(Layout, props);
-  const bodyStart = html.indexOf("<div class=\"pageShell\">");
-  const head =
-    bodyStart >= 0 ? html.slice(0, bodyStart) : "";
-  const body =
-    bodyStart >= 0 ? html.slice(bodyStart) : html;
-  return `<!doctype html><html lang="en"><head>${head}<style>${props.css}</style>${css}</head>` +
-    `<body>${body}</body></html>`;
-}