From a512b3284d2ea79fcf465d892130b6e4482ba4a4 Mon Sep 17 00:00:00 2001 From: "Edgar Y. Walker" <> Date: Mon, 16 Nov 2026 16:17:09 -0800 Subject: [PATCH 01/10] docs(site): prototype Starlight site built from docs/ with a generated API section (ITL-1170) Co-Authored-By: Claude Opus 5.5 --- .gitignore | 3 - scripts/docs_site_api.py | 410 ++++ scripts/docs_site_content.py | 450 ++++ site/.gitignore | 7 + site/astro.config.mjs | 129 ++ site/package.json | 19 + site/pnpm-lock.yaml | 4002 ++++++++++++++++++++++++++++++++++ site/pnpm-workspace.yaml | 4 + site/src/content.config.ts | 9 + 9 files changed, 5030 insertions(+), 3 deletions(-) create mode 100644 scripts/docs_site_api.py create mode 100644 scripts/docs_site_content.py create mode 100644 site/.gitignore create mode 100644 site/astro.config.mjs create mode 100644 site/package.json create mode 100644 site/pnpm-lock.yaml create mode 100644 site/pnpm-workspace.yaml create mode 100644 site/src/content.config.ts diff --git a/.gitignore b/.gitignore index 831c746a4..c82207dd9 100644 --- a/.gitignore +++ b/.gitignore @@ -180,9 +180,6 @@ venv.bak/ # Rope project settings .ropeproject -# mkdocs documentation -/site - # mypy .mypy_cache/ .dmypy.json diff --git a/scripts/docs_site_api.py b/scripts/docs_site_api.py new file mode 100644 index 000000000..4fe543ed4 --- /dev/null +++ b/scripts/docs_site_api.py @@ -0,0 +1,410 @@ +"""Generate the API reference pages of the documentation site from the source code. + +Each page under ``docs/api/`` names the objects it documents with a line +``::: `` (the mkdocstrings syntax the pages already used). This module +replaces each such line with the object's reference, generated from the source by +griffe (static analysis; the package is not imported): the signature, the Google-style +docstring with its sections, the base classes, and the public members that have a +docstring, in source order. Nothing on an API page is written by hand except the +introduction the page itself has. + +Rules (as mkdocstrings applied them): + +- A member is shown when its name does not start with ``_`` and it has a docstring; + inherited members are not repeated. +- A class's signature is its ``__init__`` signature without ``self``. +- Every object gets an anchor equal to its object path as written on the page + (``#orcapod.core.operators.Join``), so a link to it is stable whatever the headings + say. A type in a signature or a parameter list links to the object's reference when + that object is documented on one of the pages. +- A docstring that griffe reports a problem with (a parameter documented under + ``Args:`` that the signature does not have, a section it cannot parse) is an error, + as it was under ``mkdocs build --strict``. + +``docs_site_content.py`` calls ``expand_api_page`` for every API page; the module has +no command of its own. +""" + +from __future__ import annotations + +import logging +import re +from collections.abc import Iterator, Sequence +from dataclasses import dataclass, field +from functools import cache +from pathlib import Path + +import griffe + +REPO_ROOT = Path(__file__).resolve().parents[1] +SOURCE_DIR = REPO_ROOT / "src" +API_DIR = REPO_ROOT / "docs" / "api" +PACKAGE = "orcapod" + +_DIRECTIVE = re.compile(r"^::: +(?P[\w.]+) *$") +_SIGNATURE_WIDTH = 88 + +# Google docstring admonition titles and the Starlight aside each becomes. +_ASIDES = { + "note": "note", + "notes": "note", + "tip": "tip", + "warning": "caution", + "warnings": "caution", + "caution": "caution", + "danger": "danger", + "important": "caution", +} + + +class ApiPageError(Exception): + """An API page names an object that does not exist, or a docstring is malformed.""" + + +class _ProblemCollector(logging.Handler): + """Collects the warnings griffe logs while parsing docstrings.""" + + def __init__(self) -> None: + super().__init__(level=logging.WARNING) + self.problems: list[str] = [] + + def emit(self, record: logging.LogRecord) -> None: + self.problems.append(record.getMessage()) + + +@dataclass +class _Index: + """Maps object paths (as written and canonical) to their site URL.""" + + urls: dict[str, str] = field(default_factory=dict) + + def url(self, path: str | None) -> str | None: + return self.urls.get(path) if path else None + + +@cache +def _package() -> griffe.Module: + loaded = griffe.load( + PACKAGE, + search_paths=[str(SOURCE_DIR)], + docstring_parser="google", + resolve_aliases=True, + resolve_external=False, + ) + assert isinstance(loaded, griffe.Module) + return loaded + + +def _directives(text: str) -> Iterator[str]: + for line in text.splitlines(): + match = _DIRECTIVE.match(line) + if match: + yield match.group("path") + + +def _lookup(path: str) -> griffe.Object | griffe.Alias: + package = _package() + if not path.startswith(PACKAGE + "."): + raise ApiPageError(f"::: {path}: not an object of the {PACKAGE} package") + try: + return package[path.removeprefix(PACKAGE + ".")] + except KeyError: + raise ApiPageError(f"::: {path}: no such object") from None + + +def _page_url(page: str, base: str) -> str: + return f"{base.rstrip('/')}/api/{page}/" if page != "index" else f"{base.rstrip('/')}/api/" + + +@cache +def _index(base: str) -> _Index: + """Index every object documented on any API page (and its documented members).""" + index = _Index() + for page_file in sorted(API_DIR.glob("*.md")): + url = _page_url(page_file.stem, base) + for path in _directives(page_file.read_text(encoding="utf-8")): + obj = _lookup(path) + for anchor, member in _anchored(path, obj): + target = f"{url}#{anchor}" + index.urls.setdefault(anchor, target) + index.urls.setdefault(member.canonical_path, target) + return index + + +def _members(obj: griffe.Object | griffe.Alias) -> list[griffe.Object | griffe.Alias]: + """The members shown for ``obj``: public, documented, declared on it, in order.""" + if not obj.is_class: + return [] + shown = [] + for name, member in obj.members.items(): + if name.startswith("_") or not member.docstring: + continue + if member.is_alias and member.inherited: + continue + shown.append(member) + return sorted(shown, key=lambda m: m.lineno or 0) + + +def _anchored( + path: str, obj: griffe.Object | griffe.Alias +) -> Iterator[tuple[str, griffe.Object | griffe.Alias]]: + yield path, obj + for member in _members(obj): + yield f"{path}.{member.name}", member + + +# --------------------------------------------------------------------------- +# Rendering +# --------------------------------------------------------------------------- + + +def _annotation(expr: str | griffe.Expr | None, index: _Index) -> str: + """Render a type annotation as inline code, linking documented names.""" + if expr is None: + return "" + if isinstance(expr, str): + return _code(expr) + parts: list[str] = [] + plain: list[str] = [] + for element in expr.iterate(flat=True): + url = ( + index.url(element.canonical_path) + if isinstance(element, griffe.ExprName) + else None + ) + if url is None: + plain.append(str(element)) + continue + if plain: + parts.append(_code("".join(plain))) + plain = [] + parts.append(f"[{_code(str(element))}]({url})") + if plain: + parts.append(_code("".join(plain))) + return "".join(parts) + + +def _code(text: str) -> str: + ticks = "``" if "`" in text else "`" + pad = " " if text.startswith("`") or text.endswith("`") else "" + return f"{ticks}{pad}{text}{pad}{ticks}" + + +def _parameters(obj: griffe.Object | griffe.Alias) -> list[griffe.Parameter]: + if obj.is_class: + init = obj.all_members.get("__init__") + if init is None or not init.is_function: + return [] + params = list(init.parameters) + else: + params = list(obj.parameters) + if params and params[0].name in ("self", "cls"): + params = params[1:] + return params + + +def _signature(name: str, obj: griffe.Object | griffe.Alias) -> str: + """Render the signature of a class or function as a Python code block.""" + prefix = "" + if obj.is_class: + prefix = "class " + elif obj.is_function: + prefix = "async def " if "async" in obj.labels else "def " + params = _parameters(obj) + rendered: list[str] = [] + seen_keyword_only = False + previous_kind = None + for param in params: + kind = param.kind + if ( + kind is griffe.ParameterKind.keyword_only + and not seen_keyword_only + and previous_kind is not griffe.ParameterKind.var_positional + ): + rendered.append("*") + if kind is griffe.ParameterKind.keyword_only: + seen_keyword_only = True + if ( + previous_kind is griffe.ParameterKind.positional_only + and kind is not griffe.ParameterKind.positional_only + ): + rendered.append("/") + star = { + griffe.ParameterKind.var_positional: "*", + griffe.ParameterKind.var_keyword: "**", + }.get(kind, "") + text = f"{star}{param.name}" + if param.annotation is not None: + text += f": {param.annotation}" + if param.default is not None: + text += f" = {param.default}" if param.annotation is not None else f"={param.default}" + rendered.append(text) + previous_kind = kind + if previous_kind is griffe.ParameterKind.positional_only: + rendered.append("/") + returns = "" + if obj.is_function and obj.returns is not None: + returns = f" -> {obj.returns}" + one_line = f"{prefix}{name}({', '.join(rendered)}){returns}" + if len(one_line) <= _SIGNATURE_WIDTH or not rendered: + body = one_line + else: + lines = "".join(f" {r},\n" for r in rendered) + body = f"{prefix}{name}(\n{lines}){returns}" + return f"```python\n{body}\n```" + + +def _indent_continuation(text: str) -> str: + """Indent every line after the first by two spaces, for a list item.""" + lines = text.strip().splitlines() + return "\n".join([lines[0], *(" " + ln if ln else "" for ln in lines[1:])]) if lines else "" + + +def _section(section: griffe.DocstringSection, index: _Index) -> str: + kind = section.kind + value = section.value + if kind is griffe.DocstringSectionKind.text: + return str(value).strip() + if kind is griffe.DocstringSectionKind.admonition: + admonition: griffe.DocstringAdmonition = value + title = section.title or admonition.annotation or "" + aside = _ASIDES.get(str(admonition.annotation or title).lower(), "note") + return f":::{aside}[{title}]\n{admonition.description.strip()}\n:::" + if kind is griffe.DocstringSectionKind.examples: + out: list[str] = [] + for example_kind, text in value: + if example_kind is griffe.DocstringSectionKind.examples or str( + example_kind + ).endswith("examples"): + out.append(f"```pycon\n{text}\n```") + else: + out.append(str(text).strip()) + return "**Examples:**\n\n" + "\n\n".join(out) + titles = { + griffe.DocstringSectionKind.parameters: "Parameters", + griffe.DocstringSectionKind.other_parameters: "Other parameters", + griffe.DocstringSectionKind.attributes: "Attributes", + griffe.DocstringSectionKind.returns: "Returns", + griffe.DocstringSectionKind.yields: "Yields", + griffe.DocstringSectionKind.receives: "Receives", + griffe.DocstringSectionKind.raises: "Raises", + griffe.DocstringSectionKind.warns: "Warns", + } + if kind in titles: + items = [] + for element in value: + name = getattr(element, "name", "") or "" + annotation = _annotation(getattr(element, "annotation", None), index) + head_parts = [] + if name and kind not in ( + griffe.DocstringSectionKind.raises, + griffe.DocstringSectionKind.warns, + ): + head_parts.append(f"**{name}**") + if annotation: + head_parts.append( + f"({annotation})" if head_parts else annotation + ) + default = getattr(element, "default", None) + if default is not None and kind is griffe.DocstringSectionKind.parameters: + head_parts.append(f"default {_code(str(default))}") + head = " ".join(head_parts) + description = _indent_continuation(element.description or "") + items.append(f"- {head}: {description}" if head else f"- {description}") + return f"**{titles[kind]}:**\n\n" + "\n".join(items) + if kind is griffe.DocstringSectionKind.deprecated: + return f":::caution[Deprecated {value.version or ''}]\n{value.description}\n:::" + raise ApiPageError(f"docstring section {kind.value!r} is not rendered") + + +def _docstring(obj: griffe.Object | griffe.Alias, index: _Index) -> str: + if not obj.docstring: + return "" + return "\n\n".join(_section(s, index) for s in obj.docstring.parse()) + + +def _kind_label(obj: griffe.Object | griffe.Alias) -> str: + labels = set(obj.labels) + if obj.is_class: + return "class" + if "property" in labels: + return "property" + if obj.is_attribute: + return "attribute" + if "classmethod" in labels: + return "classmethod" + if "staticmethod" in labels: + return "staticmethod" + if obj.parent is not None and obj.parent.is_class: + return "method" + return "function" + + +def _render_object( + path: str, obj: griffe.Object | griffe.Alias, level: int, index: _Index +) -> list[str]: + name = obj.name + out = [ + f'', + "", + f"{'#' * level} {_code(name)}", + "", + f"{_kind_label(obj)} ยท {obj.canonical_path}", + "", + ] + if obj.is_class or obj.is_function: + out += [_signature(name, obj), ""] + elif obj.is_attribute and obj.annotation is not None: + out += [f"Type: {_annotation(obj.annotation, index)}", ""] + if obj.is_class and obj.bases: + bases = ", ".join(_annotation(b, index) for b in obj.bases) + out += [f"Bases: {bases}", ""] + doc = _docstring(obj, index) + if doc: + out += [doc, ""] + for member in _members(obj): + out += _render_object(f"{path}.{member.name}", member, level + 1, index) + return out + + +def expand_api_page(text: str, base: str = "/") -> str: + """Replace every ``::: `` line of an API page with its reference. + + Args: + text: The page as written under ``docs/api/``. + base: The site's base path, for links between API pages. + + Returns: + The page in Markdown, the ``:::`` lines replaced. + + Raises: + ApiPageError: If an object does not exist or griffe reports a problem with a + docstring it renders. + """ + index = _index(base) + collector = _ProblemCollector() + logger = logging.getLogger("griffe") + logger.addHandler(collector) + try: + out: list[str] = [] + for line in text.splitlines(): + match = _DIRECTIVE.match(line) + if match is None: + out.append(line) + continue + path = match.group("path") + out += _render_object(path, _lookup(path), 2, index) + finally: + logger.removeHandler(collector) + if collector.problems: + raise ApiPageError("docstring problems:\n " + "\n ".join(collector.problems)) + return "\n".join(out).rstrip("\n") + "\n" + + +def documented_paths() -> Sequence[str]: + """Every object path the API pages name, in page order (for tests).""" + return [ + path + for page in sorted(API_DIR.glob("*.md")) + for path in _directives(page.read_text(encoding="utf-8")) + ] diff --git a/scripts/docs_site_content.py b/scripts/docs_site_content.py new file mode 100644 index 000000000..8bcb2bf4d --- /dev/null +++ b/scripts/docs_site_content.py @@ -0,0 +1,450 @@ +"""Build the content of the Starlight documentation site from ``docs/``. + +``docs/`` is the single source of the documentation: the sample tests execute its +pages as they are. The Starlight site under ``site/`` never holds a copy in git. This +script writes the site's content collection (``site/src/content/docs/``) and its +static files (``site/public/``) from ``docs/`` on every build; both are generated and +ignored by git. + +The conversion is mechanical and deterministic. For each published page: + +- The first line, ``# ``, becomes the ``title`` front matter Starlight needs + (Starlight renders the title as the page heading, so the line is removed). +- An admonition (``!!! note "Title"`` and its indented body) becomes a Starlight aside + (``:::note[Title]``); ``warning`` maps to Starlight's ``caution``. A collapsible + admonition (``??? success "Solution"``) becomes a ``<details>`` block. +- A link to another page (``../concepts/sources.md#derivedsource``) becomes the page's + site URL (``/concepts/sources/#derivedsource``). A link to another file under + ``docs/`` (``workshop_data.py``) copies the file to the site's static files. +- The ``<!-- docs-test: skip -->`` markers of the sample tests are removed. + +A link to a page or file that does not exist, or to a page that is not published, is an +error: the build fails, as ``mkdocs build --strict`` did. The API pages +(``docs/api/*.md``) are converted the same way, after ``docs_site_api.py`` has replaced +each ``::: <object path>`` line with the reference generated from the source. + +Usage: + + uv run python scripts/docs_site_content.py + +The Astro build runs it (``site/astro.config.mjs``); there is no need to run it by hand. +""" + +from __future__ import annotations + +import argparse +import html +import json +import posixpath +import re +import shutil +import sys +import unicodedata +from collections.abc import Callable, Iterable, Sequence +from dataclasses import dataclass +from pathlib import Path + +REPO_ROOT = Path(__file__).resolve().parents[1] +DOCS_DIR = REPO_ROOT / "docs" +SITE_DIR = REPO_ROOT / "site" + +# The published pages, as glob patterns relative to ``docs/``. Everything else under +# ``docs/`` (developer material under ``docs/dev/``, the tutorial data generator) is not +# a page of the site. +PUBLISHED_PAGES = ( + "index.md", + "getting-started.md", + "troubleshooting.md", + "tutorial/*.md", + "concepts/*.md", + "reference/*.md", + "api/*.md", +) + +# mkdocs admonition types and the Starlight aside each becomes. +ASIDE_TYPES = { + "note": "note", + "info": "note", + "tip": "tip", + "hint": "tip", + "success": "tip", + "warning": "caution", + "caution": "caution", + "attention": "caution", + "danger": "danger", + "error": "danger", +} + +SKIP_MARKER = "<!-- docs-test: skip -->" + +_ADMONITION = re.compile( + r'^(?P<indent> *)(?P<marker>!!!|\?\?\?\+?) +(?P<kind>[a-z]+)(?: +"(?P<title>[^"]*)")? *$' +) +_FENCE = re.compile(r"^ *(?P<fence>`{3,}|~{3,})") +_DIRECTIVE_COLONS = re.compile(r"^ *(:{3,})") +_INLINE_LINK = re.compile(r"(\]\()(?P<target>[^)\s]+)(?P<rest>(?: +\"[^\"]*\")?\))") +_INLINE_CODE = re.compile(r"(`+)(?:.*?)\1") +_SCHEME = re.compile(r"^[a-zA-Z][a-zA-Z0-9+.-]*:") + + +_HEADING = re.compile(r"^#{1,6} +(?P<text>.+?) *#* *$") +_MARKUP = re.compile(r"[`*]|\[(?P<label>[^\]]*)\]\([^)]*\)") + + +def _heading_text(markdown: str) -> str: + """The plain text of a heading: code spans and links kept as their text.""" + return _MARKUP.sub(lambda m: m.group("label") or "", markdown) + + +def mkdocs_slug(text: str) -> str: + """The anchor mkdocs (Python-Markdown ``toc``) gives a heading with this text.""" + value = unicodedata.normalize("NFKD", text).encode("ascii", "ignore").decode() + value = re.sub(r"[^\w\s-]", "", value).strip().lower() + return re.sub(r"[-\s]+", "-", value) + + +def starlight_slug(text: str) -> str: + """The anchor Starlight (``github-slugger``) gives a heading with this text.""" + return re.sub(r"[^\w\- ]", "", text.lower()).replace(" ", "-") + + +def heading_anchors(markdown: str) -> dict[str, str]: + """Map each heading's mkdocs anchor to its Starlight anchor, for one page. + + Args: + markdown: The page body, without its title line. + + Returns: + ``{mkdocs anchor: Starlight anchor}`` for every heading outside code blocks, + repeated headings numbered as each tool numbers them. + """ + anchors: dict[str, str] = {} + seen_mkdocs: set[str] = set() + seen_starlight: dict[str, int] = {} + fence: str | None = None + for line in markdown.splitlines(): + if fence is not None: + if _is_fence_close(line, fence): + fence = None + continue + fence_match = _FENCE.match(line) + if fence_match: + fence = fence_match.group("fence") + continue + match = _HEADING.match(line) + if match is None: + continue + text = _heading_text(match.group("text")) + mk = mkdocs_slug(text) + candidate, n = mk, 0 + while candidate in seen_mkdocs: + n += 1 + candidate = f"{mk}_{n}" + seen_mkdocs.add(candidate) + sl = starlight_slug(text) + count = seen_starlight.get(sl, 0) + seen_starlight[sl] = count + 1 + anchors[candidate] = f"{sl}-{count}" if count else sl + return anchors + + +class ContentError(Exception): + """A documentation page cannot be converted (a broken link, an unknown admonition).""" + + +@dataclass(frozen=True) +class Page: + """A published page: its path relative to ``docs/`` and its Markdown text.""" + + path: str + text: str + + +def page_url(path: str, base: str = "/") -> str: + """Return the site URL of the page at ``path`` (relative to ``docs/``). + + Args: + path: The page's path relative to ``docs/``, e.g. ``concepts/sources.md``. + base: The site's base path (Astro ``base``). + + Returns: + The URL, ending with a slash: ``/concepts/sources/``; an ``index.md`` is its + directory's URL. + """ + stem = path.removesuffix(".md") + if stem == "index": + stem = "" + elif stem.endswith("/index"): + stem = stem.removesuffix("/index") + prefix = base.rstrip("/") + return f"{prefix}/{stem}/" if stem else f"{prefix}/" + + +def published_paths(docs_dir: Path) -> list[str]: + """Return the published pages under ``docs_dir``, sorted, relative to it.""" + found: set[str] = set() + for pattern in PUBLISHED_PAGES: + found.update(p.relative_to(docs_dir).as_posix() for p in docs_dir.glob(pattern)) + return sorted(found) + + +def split_title(text: str) -> tuple[str, str]: + """Split a page into its title (the leading ``# `` line) and the rest. + + Raises: + ContentError: If the page does not start with a level-1 heading. + """ + first, _, rest = text.partition("\n") + if not first.startswith("# "): + raise ContentError("the page does not start with a '# <title>' line") + return first.removeprefix("# ").strip(), rest.lstrip("\n") + + +def _is_fence_close(line: str, fence: str) -> bool: + stripped = line.strip() + return stripped.startswith(fence[0] * len(fence)) and set(stripped) == {fence[0]} + + +def _map_lines_outside_code( + lines: Sequence[str], convert: Callable[[str], str] +) -> list[str]: + """Apply ``convert`` to every line that is not inside a fenced code block.""" + out: list[str] = [] + fence: str | None = None + for line in lines: + if fence is None: + match = _FENCE.match(line) + if match: + fence = match.group("fence") + out.append(line) + else: + out.append(convert(line)) + else: + if _is_fence_close(line, fence): + fence = None + out.append(line) + return out + + +def _admonition_body(lines: Sequence[str], start: int, indent: int) -> int: + """Return the index one past the last line of the body that starts at ``start``.""" + body_indent = " " * (indent + 4) + end = start + last_content = start + while end < len(lines): + line = lines[end] + if line.strip() and not line.startswith(body_indent): + break + if line.strip(): + last_content = end + 1 + end += 1 + return last_content + + +def convert_admonitions(lines: Sequence[str]) -> list[str]: + """Convert mkdocs admonitions to Starlight asides and ``<details>`` blocks. + + Raises: + ContentError: For an admonition type with no Starlight equivalent. + """ + out: list[str] = [] + i = 0 + fence: str | None = None + while i < len(lines): + line = lines[i] + if fence is not None: + if _is_fence_close(line, fence): + fence = None + out.append(line) + i += 1 + continue + fence_match = _FENCE.match(line) + if fence_match: + fence = fence_match.group("fence") + out.append(line) + i += 1 + continue + match = _ADMONITION.match(line) + if match is None: + out.append(line) + i += 1 + continue + indent = len(match.group("indent")) + kind = match.group("kind") + title = match.group("title") + end = _admonition_body(lines, i + 1, indent) + body = [ + raw[indent + 4 :] if raw.strip() else "" for raw in lines[i + 1 : end] + ] + body = convert_admonitions(body) + pad = " " * indent + if match.group("marker").startswith("???"): + summary = html.escape(title if title else kind.capitalize()) + block = [f"<details>", f"<summary>{summary}</summary>", "", *body, "", "</details>"] + else: + if kind not in ASIDE_TYPES: + raise ContentError(f"admonition type {kind!r} has no Starlight aside") + inner = max( + (len(m.group(1)) for m in map(_DIRECTIVE_COLONS.match, body) if m), + default=2, + ) + colons = ":" * max(3, inner + 1) + label = f"[{title}]" if title else "" + block = [f"{colons}{ASIDE_TYPES[kind]}{label}", *body, colons] + out.extend(pad + b if b else "" for b in block) + i = end + return out + + +def _convert_link_targets( + line: str, resolve: Callable[[str], str] +) -> str: + """Rewrite the targets of inline links on ``line``, outside inline code spans.""" + pieces: list[str] = [] + pos = 0 + for code in _INLINE_CODE.finditer(line): + pieces.append(_rewrite_links(line[pos : code.start()], resolve)) + pieces.append(code.group(0)) + pos = code.end() + pieces.append(_rewrite_links(line[pos:], resolve)) + return "".join(pieces) + + +def _rewrite_links(text: str, resolve: Callable[[str], str]) -> str: + return _INLINE_LINK.sub( + lambda m: m.group(1) + resolve(m.group("target")) + m.group("rest"), text + ) + + +class LinkResolver: + """Turns a link written on a ``docs/`` page into a site URL. + + Args: + docs_dir: The ``docs/`` directory. + pages: The published pages, relative to ``docs_dir``. + base: The site's base path. + """ + + def __init__(self, docs_dir: Path, pages: Iterable[Page], base: str) -> None: + self._docs_dir = docs_dir + self._anchors = { + p.path: heading_anchors(split_title(p.text)[1]) for p in pages + } + self._base = base + self.assets: set[str] = set() + + def _fragment(self, page: str, fragment: str) -> str: + """Translate an mkdocs anchor on ``page`` to its Starlight anchor.""" + return self._anchors[page].get(fragment, fragment) + + def resolve(self, page: str, target: str) -> str: + """Return the site URL for ``target`` as written on ``page``. + + Raises: + ContentError: If the target is a page that is not published or a file that + does not exist. + """ + if target.startswith("#"): + return "#" + self._fragment(page, target[1:]) + if target.startswith("/") or _SCHEME.match(target): + return target + path, sep, fragment = target.partition("#") + resolved = posixpath.normpath(posixpath.join(posixpath.dirname(page), path)) + if resolved.startswith("../"): + raise ContentError(f"link {target!r} leaves docs/") + if resolved.endswith(".md"): + if resolved not in self._anchors: + raise ContentError(f"link {target!r}: {resolved} is not a published page") + if fragment: + fragment = self._fragment(resolved, fragment) + return page_url(resolved, self._base) + sep + fragment + if not (self._docs_dir / resolved).is_file(): + raise ContentError(f"link {target!r}: docs/{resolved} does not exist") + self.assets.add(resolved) + return self._base.rstrip("/") + "/" + resolved + sep + fragment + + +def convert_page(page: Page, resolver: LinkResolver) -> str: + """Return the Starlight form of ``page``. + + Raises: + ContentError: If the page cannot be converted. + """ + title, body = split_title(page.text) + lines = [line for line in body.splitlines() if line.strip() != SKIP_MARKER] + lines = convert_admonitions(lines) + lines = _map_lines_outside_code( + lines, + lambda line: _convert_link_targets( + line, lambda target: resolver.resolve(page.path, target) + ), + ) + front_matter = ["---", f"title: {json.dumps(title, ensure_ascii=False)}", "---", ""] + return "\n".join(front_matter + lines).rstrip("\n") + "\n" + + +def build_content( + pages: Sequence[Page], docs_dir: Path, out_dir: Path, public_dir: Path, base: str +) -> None: + """Write the converted ``pages`` to ``out_dir`` and linked files to ``public_dir``. + + Both directories are emptied first, so a page removed from ``docs/`` leaves the + site. + + Raises: + ContentError: If a page cannot be converted; its path is in the message. + """ + converted: dict[str, str] = {} + try: + resolver = LinkResolver(docs_dir, pages, base) + except ContentError as exc: + raise ContentError(f"a page has no title: {exc}") from exc + for page in pages: + try: + converted[page.path] = convert_page(page, resolver) + except ContentError as exc: + raise ContentError(f"docs/{page.path}: {exc}") from exc + for directory in (out_dir, public_dir): + if directory.exists(): + shutil.rmtree(directory) + directory.mkdir(parents=True) + for path, text in converted.items(): + target = out_dir / path + target.parent.mkdir(parents=True, exist_ok=True) + target.write_text(text, encoding="utf-8") + for asset in sorted(resolver.assets): + target = public_dir / asset + target.parent.mkdir(parents=True, exist_ok=True) + shutil.copyfile(docs_dir / asset, target) + + +def main(argv: Sequence[str] | None = None) -> int: + parser = argparse.ArgumentParser(description=__doc__.splitlines()[0]) + parser.add_argument("--docs", type=Path, default=DOCS_DIR) + parser.add_argument( + "--out", type=Path, default=SITE_DIR / "src" / "content" / "docs" + ) + parser.add_argument("--public", type=Path, default=SITE_DIR / "public") + parser.add_argument("--base", default="/") + args = parser.parse_args(argv) + + from docs_site_api import expand_api_page # the API generator imports griffe + + docs_dir: Path = args.docs + pages: list[Page] = [] + for path in published_paths(docs_dir): + text = (docs_dir / path).read_text(encoding="utf-8") + if path.startswith("api/"): + text = expand_api_page(text, base=args.base) + pages.append(Page(path, text)) + try: + build_content(pages, docs_dir, args.out, args.public, args.base) + except ContentError as exc: + print(f"error: {exc}", file=sys.stderr) + return 1 + print(f"wrote {len(pages)} pages to {args.out}") + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/site/.gitignore b/site/.gitignore new file mode 100644 index 000000000..d060ea707 --- /dev/null +++ b/site/.gitignore @@ -0,0 +1,7 @@ +# Dependencies and build output +node_modules/ +dist/ +.astro/ +# Generated from ../docs by ../scripts/docs_site_content.py on every build +src/content/docs/ +public/ diff --git a/site/astro.config.mjs b/site/astro.config.mjs new file mode 100644 index 000000000..56481bd47 --- /dev/null +++ b/site/astro.config.mjs @@ -0,0 +1,129 @@ +// @ts-check +import { spawnSync } from 'node:child_process'; +import { watch } from 'node:fs'; +import { fileURLToPath } from 'node:url'; +import { defineConfig } from 'astro/config'; +import starlight from '@astrojs/starlight'; +import starlightLinksValidator from 'starlight-links-validator'; + +const repoRoot = fileURLToPath(new URL('..', import.meta.url)); +// Published as a GitHub Pages project page: https://nauticalab.github.io/orcapod-python/ +const site = 'https://nauticalab.github.io'; +const base = '/orcapod-python/'; + +/** Write src/content/docs and public from ../docs (pages and generated API reference). */ +function buildContent() { + const result = spawnSync( + 'uv', + ['run', 'python', 'scripts/docs_site_content.py', '--base', base], + { cwd: repoRoot, stdio: 'inherit' }, + ); + if (result.status !== 0) { + throw new Error('docs content build failed (scripts/docs_site_content.py)'); + } +} + +/** Runs the content build before `astro build` and `astro dev`; in dev, again on every change under docs/ and src/. */ +function orcapodDocsContent() { + return { + name: 'orcapod-docs-content', + hooks: { + 'astro:config:setup': ({ command }) => { + if (command === 'build' || command === 'dev') buildContent(); + }, + 'astro:server:setup': ({ logger }) => { + let timer; + const rebuild = () => { + clearTimeout(timer); + timer = setTimeout(() => { + try { + buildContent(); + } catch (error) { + logger.error(String(error)); + } + }, 200); + }; + for (const dir of ['docs', 'src/orcapod']) { + watch(new URL(`../${dir}`, import.meta.url), { recursive: true }, rebuild); + } + }, + }, + }; +} + +const page = (label, slug) => ({ label, slug }); + +export default defineConfig({ + site, + base, + // mkdocs rendered '--' and quotes as written; so does the site. + markdown: { smartypants: false }, + integrations: [ + orcapodDocsContent(), + starlight({ + title: 'Orcapod', + description: + 'Intuitive and powerful library for highly reproducible scientific data pipelines', + plugins: [starlightLinksValidator()], + sidebar: [ + { label: 'Home', link: '/' }, + page('Getting Started', 'getting-started'), + { + label: 'Tutorial', + items: [ + page('Overview', 'tutorial'), + page('0. Setup', 'tutorial/00-setup'), + page('1. Your first stream', 'tutorial/01-first-stream'), + page('2. Computing with function pods', 'tutorial/02-function-pods'), + page('3. Reshaping with operators', 'tutorial/03-operators'), + page('4. Many rows into one', 'tutorial/04-many-rows-into-one'), + page('5. Keeping results', 'tutorial/05-pipeline-job'), + page('6. Re-runs and caching', 'tutorial/06-reruns-and-caching'), + page('7. Working with files', 'tutorial/07-files'), + page('8. Inspecting and tracing', 'tutorial/08-inspecting-and-tracing'), + page('9. When things go wrong', 'tutorial/09-when-things-go-wrong'), + page('10. Where next', 'tutorial/10-where-next'), + ], + }, + { + label: 'Concepts', + items: [ + page('Sources', 'concepts/sources'), + page('Streams', 'concepts/streams'), + page('Operators', 'concepts/operators'), + page('Function Pods', 'concepts/function-pods'), + page('Pipelines and Jobs', 'concepts/pipeline-job'), + page('Your Own Data Types', 'concepts/your-own-data-types'), + page('Arrays and Tensors', 'concepts/arrays'), + page('Logical Type Identifiers', 'concepts/logical-type-identifiers'), + page('Identity & Hashing', 'concepts/identity'), + page('File and Path Types', 'concepts/file-types'), + page('File Hash Caching', 'concepts/file-hash-caching'), + ], + }, + { + label: 'API Reference', + items: [ + page('Overview', 'api'), + page('Sources', 'api/sources'), + page('Streams', 'api/streams'), + page('Operators', 'api/operators'), + page('Function Pods', 'api/function-pods'), + page('Databases', 'api/databases'), + page('Nodes', 'api/nodes'), + page('Pipeline', 'api/pipeline'), + page('Types', 'api/types'), + ], + }, + { + label: 'Reference', + items: [ + page('Hashing', 'reference/hashing'), + page('Golden hashes', 'reference/golden-hashes'), + ], + }, + page('Troubleshooting', 'troubleshooting'), + ], + }), + ], +}); diff --git a/site/package.json b/site/package.json new file mode 100644 index 000000000..2953e8d4e --- /dev/null +++ b/site/package.json @@ -0,0 +1,19 @@ +{ + "name": "orcapod-docs-site", + "private": true, + "type": "module", + "engines": { + "node": ">=22.23.4" + }, + "scripts": { + "dev": "astro dev", + "build": "astro build", + "preview": "astro preview" + }, + "dependencies": { + "@astrojs/markdown-remark": "7.3.9", + "@astrojs/starlight": "0.43.1", + "astro": "7.4.12", + "starlight-links-validator": "0.27.0" + } +} diff --git a/site/pnpm-lock.yaml b/site/pnpm-lock.yaml new file mode 100644 index 000000000..ee25c4283 --- /dev/null +++ b/site/pnpm-lock.yaml @@ -0,0 +1,4002 @@ +lockfileVersion: '9.0' + +settings: + autoInstallPeers: true + excludeLinksFromLockfile: false + +overrides: + sharp: '-' + +importers: + + .: + dependencies: + '@astrojs/markdown-remark': + specifier: 7.3.9 + version: 7.3.9(supports-color@10.2.2) + '@astrojs/starlight': + specifier: 0.43.1 + version: 0.43.1(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(astro@7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1))(supports-color@10.2.2) + astro: + specifier: 7.4.12 + version: 7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1) + starlight-links-validator: + specifier: 0.27.0 + version: 0.27.0(@astrojs/starlight@0.43.1(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(astro@7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1))(supports-color@10.2.2))(astro@7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1))(supports-color@10.2.2) + +packages: + + '@astrojs/compiler-binding-android-arm64@0.5.3': + resolution: {integrity: sha512-ThyoCqtrdp6UwmMvScluDll4vvj4kXwUPKHYozLbXJKPH5zrJ8sr5xQJVOk0YvgBrCvGBA/lPVVLyEp1aLuBYg==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [arm64] + os: [android] + + '@astrojs/compiler-binding-darwin-arm64@0.5.3': + resolution: {integrity: sha512-zMI4ndCVCd0Wsrm8sXVcIk6uviKsgndFLnxqNd6Qx26LINSkb0lQ7SL8gKyGcTu0hJRTBwl7Y1WcpMk37aeaKQ==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [arm64] + os: [darwin] + + '@astrojs/compiler-binding-darwin-x64@0.5.3': + resolution: {integrity: sha512-Ce51oGlDgBAwoVOy5Y4FeIqFkXbS/vJkIAPN5pXIYchn/3izF4c2t//KuUZJopwzD6Kblj46kKiqmxRUt/mAJg==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [x64] + os: [darwin] + + '@astrojs/compiler-binding-linux-arm64-gnu@0.5.3': + resolution: {integrity: sha512-WCBGgpmUqbuWW3KAsNOKRXDeQIAeQLftZhZ+CNyl3eg4JtkfZRXHav2qItzVg6ODyzmS2e+QkpgsQuwMSInGgA==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [arm64] + os: [linux] + libc: [glibc] + + '@astrojs/compiler-binding-linux-arm64-musl@0.5.3': + resolution: {integrity: sha512-DRcjEOFWcMbaaTsbOEferYozr2zDUf/roDzcF6WxHSSto+rqZ1N87xxj/pjOpz0JtTBlZ3V59nZGONcNiQUSWw==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [arm64] + os: [linux] + libc: [musl] + + '@astrojs/compiler-binding-linux-x64-gnu@0.5.3': + resolution: {integrity: sha512-8rIMmEFtuVe5mMvwBR59uSHZL7CaJ/CPm5Hh3r3Bd5JLoSPkBbl1xk8kwUkNKJ0QSbGEFdWkUnx73JRZq46i2A==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [x64] + os: [linux] + libc: [glibc] + + '@astrojs/compiler-binding-linux-x64-musl@0.5.3': + resolution: {integrity: sha512-+sZCsIXq/PQBiemALIr+GbERKQbQ82mHW2ibJUlCDtsjyFA/8Udm8WGZhS7AGjb2P9ekQ4j7Z8dbxb0f3E0oZw==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [x64] + os: [linux] + libc: [musl] + + '@astrojs/compiler-binding-wasm32-wasi@0.5.3': + resolution: {integrity: sha512-cEhZ7XAoZYffJdNYb3MDWci1UKhSEjPN+DMaLEB8X1tKlhlYNw9eVWUyNZTe1gb3nr7JJBVXdXDioqE00dyVLQ==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [wasm32] + + '@astrojs/compiler-binding-win32-arm64-msvc@0.5.3': + resolution: {integrity: sha512-Vcg6+NlU2SOmVGweQEmufu40MHuDuRR80dp9xNLutBWGdJG1HP0XivjGWKGkx/2EK3HN5rwB2NwPgBNDkhKsnQ==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [arm64] + os: [win32] + + '@astrojs/compiler-binding-win32-x64-msvc@0.5.3': + resolution: {integrity: sha512-Mt5bK4l5ZcUdNcVxJ7VVt2x5Ck46cXgxCmIhT8sVyUST04FBRYqcYTXQLvy1Py4ejglcWRxAS6z+jBVHs3LPfg==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [x64] + os: [win32] + + '@astrojs/compiler-binding@0.5.3': + resolution: {integrity: sha512-fHG6eWKvnSlV11dUMZSi4AynOGjVbNBgZZc704Hi9DW8WeKtbsS7fJQT3omz1Nba+5mccLQQGAWOQ65cnuNLtg==} + engines: {node: ^20.19.0 || >=22.12.0} + + '@astrojs/compiler-rs@0.5.3': + resolution: {integrity: sha512-rNSAYm5IcRJMpNm+cSMaaPNCmzCXIdiz67kcBwC1qN8eTmO48wEJ6hZdlGq60+0HIHwUlncfaMxti1Fk2uJu7w==} + engines: {node: '>=22.12.0'} + + '@astrojs/internal-helpers@0.13.2': + resolution: {integrity: sha512-SWiNS+OMrhwWYzJENTekHUyUCMKB+tdU6D4v1ZNIU1ZHh2mScQ8WIs0J6AJ8KPXkIrs9+EZU7Rm2CstfThyVnw==} + + '@astrojs/markdown-remark@7.3.9': + resolution: {integrity: sha512-Ni/6qKgAzaU3mFwbk6OIdwLfDpNjerauwiJowbG1swv0RQkddsyeit8re5jS/8MrYPJzL6Dtw0grHAyqLrC6EA==} + + '@astrojs/markdown-satteri@0.4.10': + resolution: {integrity: sha512-3h/wheVjZIcP/m295nkiUjOvCsCs6QpvZ3l4BfDU4ghNQcrcFrNVu1+K+I+YT61hH9tuCDQiGdF8QDzfDoG42w==} + + '@astrojs/mdx@8.1.6': + resolution: {integrity: sha512-Zq4iblpzpboFbmdLhPy8Pd9z6yGDpSXkTO+KCeV8Ugr5pDBxoFD0LJqw7MKHMEzw/0Y7Id8jIpNlm7pQhT118g==} + engines: {node: '>=22.23.4'} + peerDependencies: + '@astrojs/markdown-remark': ^7.3.0 + '@astrojs/markdown-satteri': ^0.4.0 + astro: ^7.2.10 + peerDependenciesMeta: + '@astrojs/markdown-remark': + optional: true + + '@astrojs/prism@4.1.2': + resolution: {integrity: sha512-jMrUEpFDarDO1KWPvVc9eSa8DSfwBlwEOHwX+8zvZQpiqXRGDxFnOXHsYqV6DP7w+0qIgTr98gS1GdQlm8ypWg==} + engines: {node: '>=22.23.4'} + + '@astrojs/runtime@0.1.1': + resolution: {integrity: sha512-2Tr9IJ4aQBPDFzlSLq139eWS9OZnuhL0yU2al8cCpnTE/RszygSyGIP8piBmEio1zDUaItb/+YxxsrmldUCBmg==} + + '@astrojs/sitemap@3.7.5': + resolution: {integrity: sha512-rxSbFcxdcOoVRR02q0aFxyZ6chwXZpUOHMg8e+3iWPo7xYV4hlYBU4ztFd1Xl/pWtr6pe+TVCFKJfyPe0sp8iA==} + + '@astrojs/starlight@0.43.1': + resolution: {integrity: sha512-GhTK+93UNejoQThnYbEkJAlRJiOtctxOCnFtLcUMSTraT75vzS1E89xdMtKOdKcUDD2wx+taJxsfrA3UBs0QgQ==} + peerDependencies: + '@astrojs/markdown-remark': ^7.3.0 + astro: ^7.2.10 + peerDependenciesMeta: + '@astrojs/markdown-remark': + optional: true + + '@astrojs/telemetry@3.4.2': + resolution: {integrity: sha512-2JOMRUxJrBSfiVDfeKLv1wBmvSIx1Y6u2YEO8awZ9qSq3u/rNAiUyFdOYi8dHv91kHrmYEQX7pRDw0J4xyj3UA==} + engines: {node: '>=22.23.4'} + + '@astrojs/vite-plugin-astro@0.1.3': + resolution: {integrity: sha512-yj+xGnr3HeHUtIdra/tWizJuisBoxAuWlBTElMlf22FpSxinrTwTl/dqftG0D2BsQTcn4/shgCCUwcnkcZ8buA==} + peerDependencies: + vite: ^8.3.3 + + '@babel/helper-string-parser@7.29.14': + resolution: {integrity: sha512-CXvKMFvM80ihI7Vox9jb+kQjnyjESQNPM+vB7U0Zz6TWuZA+Z/FL0QPMH300h33qJtIx+REeBhXqWOPW48TcAQ==} + engines: {node: '>=6.9.0'} + + '@babel/helper-validator-identifier@7.29.7': + resolution: {integrity: sha512-qehxGkRj55h/ff8EMaJ+cYhyaKlHIxqYDn682wQD7RNp9UujOQsHog2uS0r2vzr4pW+sXf90NeeayjcNaX3fFg==} + engines: {node: '>=6.9.0'} + + '@babel/parser@7.29.14': + resolution: {integrity: sha512-VL220vXuyO2z3rNIQwY7ftj9UwpqOt+33sH+sBWkOekbsSR2g7EEMnOx24ZlCH0xOA3DM/33SifVFGbnJD8r/w==} + engines: {node: '>=6.0.0'} + hasBin: true + + '@babel/types@7.29.14': + resolution: {integrity: sha512-UjI/dKmwJwT9pOszJitq2G6EObZPnsZUfdCr92z2TlF3EZK9J3EdfOKUrCzHl6wFthbzwhzl1Soc/UIwxRiq6w==} + engines: {node: '>=6.9.0'} + + '@bruits/satteri-android-arm64@0.11.7': + resolution: {integrity: sha512-ej+1rIKs+yb6/OtcIe1SO22OXjJV0qqUopl5VNZF8Sqc/Pj4m1DXoqBQsPxW5OUYYiDUymIy6hnnn8M78VYk2w==} + cpu: [arm64] + os: [android] + + '@bruits/satteri-darwin-arm64@0.10.5': + resolution: {integrity: sha512-27KTVl4TJkVahMy/ohyA7qd4938G5UNneFUz/PsScYfpIhj0IVAS23mpcJXdPF44sa6nva198lmV/cKIb2YPyA==} + cpu: [arm64] + os: [darwin] + + '@bruits/satteri-darwin-arm64@0.11.7': + resolution: {integrity: sha512-yllQOX1kVWrwqL7tamQlp4NP0loIb4KuadjuNrAe4JEOerHpgYISPRDb8DqLipgvP7Ks4e87LydZpdakMR1rhQ==} + cpu: [arm64] + os: [darwin] + + '@bruits/satteri-darwin-x64@0.10.5': + resolution: {integrity: sha512-IjnLe3nKspq6qaeqGgjT7MT8VrTV74yWRlaag7ZdNsI8TDAYZ0iPxMCo+9KQZHUk5EyVB+reBI/PFWL5KuFw9Q==} + cpu: [x64] + os: [darwin] + + '@bruits/satteri-darwin-x64@0.11.7': + resolution: {integrity: sha512-RMQrKzEZRZSiYyLFifiSuk0nBH6uAY1TVMNR/h/aE4rr2OS6l82e4MJTpC6H/tqSMoE+3CwbkUKBQGLHIweYlg==} + cpu: [x64] + os: [darwin] + + '@bruits/satteri-freebsd-x64@0.11.7': + resolution: {integrity: sha512-EFlqw+RDRo3wYdy1ZSR/dNYhfWjuZL86PYwRcpLWWEZskjfpNnhIdxS13Xw2QJE1hSjTGVq4aZaVvlUjoj8p5A==} + cpu: [x64] + os: [freebsd] + + '@bruits/satteri-linux-arm64-gnu@0.10.5': + resolution: {integrity: sha512-glkYXZCJywjP13v67eAyAMSJdF+ncvEbYvgi/wOtffL9tQ27lr/zsyzUfgs+ovjJ9d8JNQKiXeiArJcX8PJL9w==} + cpu: [arm64] + os: [linux] + libc: [glibc] + + '@bruits/satteri-linux-arm64-gnu@0.11.7': + resolution: {integrity: sha512-aeH365GHaqv01wRSiHaGUlpL28U8e9UnV9LxjIF6BOyTj71/M5bop4HKomcis4VxFZjd68fDqNyU22yFkF/h7A==} + cpu: [arm64] + os: [linux] + libc: [glibc] + + '@bruits/satteri-linux-arm64-musl@0.10.5': + resolution: {integrity: sha512-yWdgG1g17Nh2QyGVlFUxGRa3FEFwiMcpZEyMNWkbM3deC94cmVc+/i9OuyFpdKuWo3GkgoCtYVOoxk1uCnCZIA==} + cpu: [arm64] + os: [linux] + libc: [musl] + + '@bruits/satteri-linux-arm64-musl@0.11.7': + resolution: {integrity: sha512-72WlBhuwOHm+2Nv4Qf1WzfS75PHOLz81sYkDJnmj0Rm2C4Xax5faSiTDt7vWo1IcK6rDlkuRDNnWIw8uIKWuVQ==} + cpu: [arm64] + os: [linux] + libc: [musl] + + '@bruits/satteri-linux-x64-gnu@0.10.5': + resolution: {integrity: sha512-FVaLoPT1fBgGl0J+AYebyyXJYBachGl8Oyyrf1lye4RTqCB4S0Gwkj1uM9RJyThUOvx5VUmAT1CnNh1SFHA+kw==} + cpu: [x64] + os: [linux] + libc: [glibc] + + '@bruits/satteri-linux-x64-gnu@0.11.7': + resolution: {integrity: sha512-gDp4v1jjckeNCetLtrMUfDV4CKGYL6fayDPdoaQq09nkDCSrclxEFK7kAmRuHhoalgsao4bZMFqQr3HQtN2NEQ==} + cpu: [x64] + os: [linux] + libc: [glibc] + + '@bruits/satteri-linux-x64-musl@0.10.5': + resolution: {integrity: sha512-EHpVAx2bqW3GINHTKkljtxVfQmVDGWIuwOYOP5YghTj+0PkBa2o8oKPRtQ9Kbsr1Fye8jtUcDjhwj2jMNugZKg==} + cpu: [x64] + os: [linux] + libc: [musl] + + '@bruits/satteri-linux-x64-musl@0.11.7': + resolution: {integrity: sha512-zqzSpQLA6V3J/TO2Vjuc1VRQPIQQdoSYmzKKFL+3GwGlbXiFQP2ZUDSLw9xlm0tTKXkCM9ANr4jMiDASZ+JGUw==} + cpu: [x64] + os: [linux] + libc: [musl] + + '@bruits/satteri-wasm32-wasi@0.10.5': + resolution: {integrity: sha512-ypz8c/Zmipxp4IoeDa228Gstv6TLzVmNs3yC6wKCoNSOjx1iwpgzu87Y3hTkXFdwChVGU85qeUDuOIarGUZQLw==} + engines: {node: '>=14.0.0'} + cpu: [wasm32] + + '@bruits/satteri-wasm32-wasi@0.11.7': + resolution: {integrity: sha512-L46f6rtlaBR4fsTWGCTFcXtbtka2GyM3l9TsmE0FgTxjXGq+sndYg5X3hzlhWDkNvJpRtCHCmgTRJ5+cIi4o3A==} + engines: {node: '>=14.0.0'} + cpu: [wasm32] + + '@bruits/satteri-win32-arm64-msvc@0.10.5': + resolution: {integrity: sha512-siTV88nb0LRqNpkL2gXboqCwVdq95sLtzMHS1/3eONV2gLbB3NAK46wmSMvCO/yquBvI2lvaFIfd8P12ecsxBw==} + cpu: [arm64] + os: [win32] + + '@bruits/satteri-win32-arm64-msvc@0.11.7': + resolution: {integrity: sha512-R2+o6EbJK4pqbd086H9BGUVYAyZ5F6FnShfoyRIu0Zu9DTE3H6EU/Z+ua7p9dmYf6JQQbE9DCwwavi4xiaGAhQ==} + cpu: [arm64] + os: [win32] + + '@bruits/satteri-win32-x64-msvc@0.10.5': + resolution: {integrity: sha512-C3IfPvfvMXmlzBxaMPKFS1XiuV9pu2mC7YqkPk7PSvTgPZ8gbdASIpHpztDLvTTQjqZ0z1Ol8tK5X+V6XXC0wQ==} + cpu: [x64] + os: [win32] + + '@bruits/satteri-win32-x64-msvc@0.11.7': + resolution: {integrity: sha512-OIyBFJ35uMu5CH5RWnIR3bKsZwScKZ7vXmhCohZ+qonT1SkxmHCEf4H8YRWThRL2EXdVDjkjhfOsaiA4O24Vvw==} + cpu: [x64] + os: [win32] + + '@capsizecss/unpack@4.0.1': + resolution: {integrity: sha512-CuNiSqg7+e1cO/GjffyMOm5Tt2jUF9CWHHnvQ/UkqvtkGfHdgwEC0wpmq7fkN3gxwpRnrAN0WzO3vREKmNolMQ==} + engines: {node: '>=18'} + + '@clack/core@1.6.0': + resolution: {integrity: sha512-4GZynIB2IIe431odxesswvWTCP6orvqd6e2b07b3VFWBQRqUqIHc/EPIZwFoKS692QBp+ooPuXKaJV8g4kXuYA==} + engines: {node: '>= 20.12.0'} + + '@clack/prompts@1.9.0': + resolution: {integrity: sha512-tEj8X2No2A1c9NDnZECxiiJ8TP3vmFlN9tLlLeSaMqVW4tUmVG2R4qpv/eP4zymWxnymYLkLcIYVV0VcWj3RCQ==} + engines: {node: '>= 20.12.0'} + + '@ctrl/tinycolor@4.3.1': + resolution: {integrity: sha512-miLzcPaPApfChfqxxDw7nsTA8hlU4M9GZnL3UVdaxgyRzewiYaI0lsmn72SOARHgVDlVSagTTh2zWt4OcxYmmg==} + engines: {node: '>=14'} + + '@emnapi/core@1.11.1': + resolution: {integrity: sha512-RSvbQmHzdKzNsLYa/wHrbc3KN4sYLKAdPZxqiM2HATqv/SBk2/ENSHpvXGaLOMcsAyz0poEGqkmmKYG3OWiJEQ==} + + '@emnapi/core@1.11.3': + resolution: {integrity: sha512-zLpS5asjEb7lq8jYLq37N6XKaE41DIexlY1rF/z4/tIl3wo13Sqm28fRyfIsKZD+NZ8mM5RoKkpW/rBcuoSZSg==} + + '@emnapi/core@2.0.0-beta.2': + resolution: {integrity: sha512-MzCVoWtcg4Pm2B3je5mMvYMvj3MmBKw+fU7vbsJc9/iT8ip6/eYIHo/Dsm/mr+wsHB6SEyJDuxB09Yy6r/8+4A==} + + '@emnapi/runtime@1.11.1': + resolution: {integrity: sha512-vgj7R3y3Wgx24IQaGPA/R6YFXLHVMOZ0uVEyIQPaWs+rd1AzfEMXlAC22FYwO1XkKR6NPsq7mUandH8oIRdZFw==} + + '@emnapi/runtime@1.11.3': + resolution: {integrity: sha512-Xz4Tpyki7XyrpbUK1jR1AhdAdaXyhhY4lZ3neLodmhpuWfy2PAQN5B46sAiU4liOXGLkHypn/qU+jvfWSCYYLA==} + + '@emnapi/runtime@2.0.0-beta.2': + resolution: {integrity: sha512-JcrSPzPvZuNZvJqPTF9Fw25LbOJ8avzFVlaf2grmH4Cku0oGP47tRgqPZadcfj3YoZMHkFVnCYFbQM8I+i5QEw==} + + '@emnapi/wasi-threads@1.2.2': + resolution: {integrity: sha512-c95qOXkHdydNKhscBTebqEC1CVAZpyqOfVfBzQ1qgzyl3gfeldUjIggDbIZgDKsHLgnsM+igH7TJ/eAasaVuMA==} + + '@emnapi/wasi-threads@1.2.3': + resolution: {integrity: sha512-ELEBe8PsLvvJ6QMr0zLt8ffvOHW/dc1m3CEzNMg7aJUv3bMaoDtw2TXyDAwkYBuroxxuHEwhRTLJSe5sya547g==} + + '@emnapi/wasi-threads@2.2.0': + resolution: {integrity: sha512-JP7OYH38Q7+pyTAe14raZHLQIK7BDKbdwji+Xi3pcd/6QkJYQH3SX4wu6EplGrGJWRepoNzedfm0G3B9Z4e9Rw==} + + '@expressive-code/core@0.44.3': + resolution: {integrity: sha512-pffktF0TJoxC08dgNcutl/0LcSnTrjF6vXR39qVpwZ0EyxpwO9zjI7dbni6sO7w3yHpRBO0voLFvhzB+EPJRsA==} + + '@expressive-code/plugin-frames@0.44.3': + resolution: {integrity: sha512-ysW4VXk9vXEliA99Ur6ApUepVtx74sPolp6o/j45BRjZQoL5O6kXKMhSP4koQLih8HbC5B3ImIvO+HKKhkv/oA==} + + '@expressive-code/plugin-shiki@0.44.3': + resolution: {integrity: sha512-jAibAZPG7lDmi61EFJADZjoSZzjHiwZZdbbgR/mTlWXM4ON/Pyo/9tB2vrqQNKylsci6jqtCi6idrwqQXF53xA==} + + '@expressive-code/plugin-text-markers@0.44.3': + resolution: {integrity: sha512-4Ae2xRSDV5kdWPsi40xWbOtoihbzM0zLVjQKkDAnD5KzFXl+6/kd+VhuWOlTRVaJ5cqGk++vCbAaf0MR1XbZlw==} + + '@jridgewell/sourcemap-codec@1.6.0': + resolution: {integrity: sha512-T7jf+5zgsZHwNJ4lvQ7/aezbyk0nNX+zJVWpmHA7VYsEx7a7qr5Rg5IbtJFqkgze5Y2sruq1RUY8Q837Od7iFw==} + + '@mdx-js/mdx@3.1.1': + resolution: {integrity: sha512-f6ZO2ifpwAQIpzGWaBQT2TXxPv6z3RBzQKpVftEWN78Vl/YweF1uwussDx8ECAXVtr3Rs89fKyG9YlzUs9DyGQ==} + + '@napi-rs/wasm-runtime@1.2.6': + resolution: {integrity: sha512-mRyDmEw9/fCDXCGfL1sbgIw/GUK0PVxRW4YwgPN61F3LQ+fSyoBFarJVzgGyhF6kRzEQZ0FejDqm4WLXSeqQmw==} + engines: {node: ^20.19.0 || ^22.13.0 || >=23.5.0} + peerDependencies: + '@emnapi/core': ^1.7.1 || 2.0.0-beta.2 + '@emnapi/runtime': ^1.7.1 || 2.0.0-beta.2 + + '@napi-rs/wasm-runtime@1.2.7': + resolution: {integrity: sha512-zJccwplOAbgfZju95IUHazLnx9RAPtPN2YGJXI6UbrgeaR9QfPjGrQL6ERkSAtnVCA4Q+83ApGyaX5zdpCaKkQ==} + engines: {node: ^20.19.0 || ^22.13.0 || >=23.5.0} + peerDependencies: + '@emnapi/core': ^1.7.1 || 2.0.0-beta.2 || 2.0.0-beta.3 + '@emnapi/runtime': ^1.7.1 || 2.0.0-beta.2 || 2.0.0-beta.3 + + '@oslojs/encoding@1.1.0': + resolution: {integrity: sha512-70wQhgYmndg4GCPxPPxPGevRKqTIJ2Nh4OkiMWmDAVYsTQ+Ta7Sq+rPevXyXGdzr30/qZBnyOalCszoMxlyldQ==} + + '@oxc-project/types@0.156.0': + resolution: {integrity: sha512-1Duyg48TdJNdyhEB8Xn1L36bT9Pv6GUtlKjHxOys8xkaF/rQq3XJE+bAurSK/AgIz5mGFsb77cn9Pb20+WCScw==} + + '@pagefind/darwin-arm64@1.6.0': + resolution: {integrity: sha512-611gl64aqN12UcMyKPtZ8+vRWBKlJFSh2JgO8uScxa1Eyjo1dXz9r4wZuRno0yCUE/KN0FauEoKZ3KEwUYHCCg==} + cpu: [arm64] + os: [darwin] + + '@pagefind/darwin-x64@1.6.0': + resolution: {integrity: sha512-rd3ZbtuxyYqjASKZAPuIV7eeQQHJ7VYpoNKKG8CvglaD3g30eT5Nb7XGNLYwVReBsCccpkURwrGwWjSwr8nyQQ==} + cpu: [x64] + os: [darwin] + + '@pagefind/default-ui@1.6.0': + resolution: {integrity: sha512-Wj93IzlLnaYYrMpOYrsqUerzA7+Vrs5Ri1U78hBh3zuKHNVkcjApNo5DUM99MzAam6f437VGG64jDenAObIt+w==} + + '@pagefind/freebsd-x64@1.6.0': + resolution: {integrity: sha512-d+sXqsaThszmPWGVDSRKqIz9GpZcj/bAksNZfg19asSxU0ogNPOMND4kV4giQvOjPFMsltUFf6hQJfoHQ6+hSQ==} + cpu: [x64] + os: [freebsd] + + '@pagefind/linux-arm64@1.6.0': + resolution: {integrity: sha512-SLB2I+XqCZma8NvIGIH8nyKblgKIxw5PmqsVtofWOKxNHhEtOEsddbqU+hsrNcT3EV0faM6UmKDHVIxcPYq29w==} + cpu: [arm64] + os: [linux] + + '@pagefind/linux-x64@1.6.0': + resolution: {integrity: sha512-IbMSx/+Vr/Xk0TTBlLkjgK+rvnbOXGmmb2/MKxQu99AR5DsqQoV3NKEA9PQz2tAhuCZjeD5xJBp4w5N5DHIC7Q==} + cpu: [x64] + os: [linux] + + '@pagefind/windows-arm64@1.6.0': + resolution: {integrity: sha512-wUrniW3REr7VWJHz6xE6F/p/AQgHDFpGZiY9sbWT71KfEijDE5Jnc37V8zc7cilV9h/QkwJGXoEP2+ZLwDmhtw==} + cpu: [arm64] + os: [win32] + + '@pagefind/windows-x64@1.6.0': + resolution: {integrity: sha512-cUA2+yXfbymdJllyMjY5YTBwuOgh0/H53Pn5fYKjDnDjk154Ft4U5RVj3TenWySPL/jG6zJfARUWSlyUyXHlZw==} + cpu: [x64] + os: [win32] + + '@rolldown/binding-android-arm-eabi@1.2.19': + resolution: {integrity: sha512-e+Ebe0WT+9tbXmNKPIiC8YrWAHYwug3m6i4p3rZGGulfZri1jtI4HslT+OZnFf/OIHowWF71DTlHwXBP2SiA7A==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [arm] + os: [android] + + '@rolldown/binding-android-arm64@1.2.19': + resolution: {integrity: sha512-hOombrTJ+szt2ciEzS7oCA78lMPBgF5UMQWCJIyNfnrI7GLl8HYoFqCnpL2gcPOaXMqryGCU5ExdQKyDDcC+yA==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [arm64] + os: [android] + + '@rolldown/binding-darwin-arm64@1.2.19': + resolution: {integrity: sha512-XoMA2pwCKGTQzUjPgtRwkedH4WmXhdIPKT6l6oOxd1PUbNodGI6DcBekgN7EC//+x3pfBYX/qL1gNmZAqivw5g==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [arm64] + os: [darwin] + + '@rolldown/binding-darwin-x64@1.2.19': + resolution: {integrity: sha512-zo8EsSSwMZCY/e+fRnGaX02YGgvJD0yvhNi/9hpGPA2MJ9ZF8dPCw75UGfpI6OpQ/myR/dIYmogRvqiZD0TrXg==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [x64] + os: [darwin] + + '@rolldown/binding-freebsd-x64@1.2.19': + resolution: {integrity: sha512-O8ISAOfI1nj7AuBPd30FSF47z7f7lzlk5poQVGgiikvQuGEBFYvW8ki+UEnT+YJPnNGjQzn304klt4O9FUE7mA==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [x64] + os: [freebsd] + + '@rolldown/binding-linux-arm-gnueabihf@1.2.19': + resolution: {integrity: sha512-/lYCba5NO0yq4S0jGMH8QTBtkvQxoXjoQWzF5BcWp9MjB9jxVRD1GQDNofkVjcOj30DWyhLIN/4Oe60JKzaONw==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [arm] + os: [linux] + + '@rolldown/binding-linux-arm64-gnu@1.2.19': + resolution: {integrity: sha512-pm/apFMBnSbFb3O6nG5pHO1iqHhZrjGDFEjSm+ot9J17XXPvH9L90y5h+jgfHCE+Qdlsvy8qKEcU4VKxgjD+vA==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [arm64] + os: [linux] + libc: [glibc] + + '@rolldown/binding-linux-arm64-musl@1.2.19': + resolution: {integrity: sha512-K1SmQp3FFichn8oqrNIwvFoZ5wcvjC7goBzpaMNvLf9FZc+QB/QvLmnpJZgAAGHiD980tP8FZZnXk2K94rvlxg==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [arm64] + os: [linux] + libc: [musl] + + '@rolldown/binding-linux-ppc64-gnu@1.2.19': + resolution: {integrity: sha512-I0xwD57jP/3A7+5UPZin2w8Y7XHEmEM5zqpYZOcQ45MlNW6tUJUziymV3yRr7rL4vwyfEcRsRksC4a7Kc08p5Q==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [ppc64] + os: [linux] + libc: [glibc] + + '@rolldown/binding-linux-s390x-gnu@1.2.19': + resolution: {integrity: sha512-BrtEHT24SNXj9HiXqy+s/kXiSiQGt6EKCPUlRirAoIioVxKGnbXBUEkbZASAei7iZJB0/Ynm+0JP00Ipx7AnSw==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [s390x] + os: [linux] + libc: [glibc] + + '@rolldown/binding-linux-x64-gnu@1.2.19': + resolution: {integrity: sha512-rm75/9DkHKeU2WnA8w4X94WGYgLlDCFCfkQC+4bguVJmC/jvDRv2B+2wLOYhyE0fVuv7//Ckk39OoOufyCu76Q==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [x64] + os: [linux] + libc: [glibc] + + '@rolldown/binding-linux-x64-musl@1.2.19': + resolution: {integrity: sha512-irh/4+iYFM4GAzpluDErgjz89bj6NDtqqMAG/6O1LG38Ed3NpyebzCpcVNkFW8uhy+/3/BocUvnXDR33CXWe9A==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [x64] + os: [linux] + libc: [musl] + + '@rolldown/binding-openharmony-arm64@1.2.19': + resolution: {integrity: sha512-+KWTWNoPt+CfSq94CiceWu3yPE+QzkaG+phPyz9G60tmZLwfQkcA4AeksafzvJAw4pvg1mcd5a1TkUqVv0s4JA==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [arm64] + os: [openharmony] + + '@rolldown/binding-wasm32-wasi@1.2.19': + resolution: {integrity: sha512-7EH+skOsl5qpWnK0vzamgJFhOv1cwxQpsxm8tI883K9fur5c27p8q87fzEO6BbBPabA2/+s/zR63/pLc137iOg==} + engines: {node: ^20.19.0 || ^22.13.0 || >=23.5.0} + cpu: [wasm32] + + '@rolldown/binding-win32-arm64-msvc@1.2.19': + resolution: {integrity: sha512-3Q1Yg1Q7tEvBWoZf5rFvG/GKZQPgwfru+p4wBajDfJFBs0SHCpL++dfTjW9gyAKd1T7ZpIYvdaUax7Pa/IhFVQ==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [arm64] + os: [win32] + + '@rolldown/binding-win32-x64-msvc@1.2.19': + resolution: {integrity: sha512-y/sqRRc6d7hECzOFc5n3LSeqctmIp9mMjY1Kq4s14uLPd/LZ4z7i1zrW6fMtp2mPeuQIC4e6ULMcwQzMomqQag==} + engines: {node: ^20.19.0 || >=22.12.0} + cpu: [x64] + os: [win32] + + '@rolldown/pluginutils@1.1.1': + resolution: {integrity: sha512-glFIJDvLNDtJhT9qrMFWLPbvS+skxgt4L0K8Ei2YtnhPysAJnsI7nyxSJxKj4ADeKX0OLjC4ntRkwpLOoS3rwA==} + + '@shikijs/core@4.6.0': + resolution: {integrity: sha512-bfd4OKgvoyXYiYmMRuleA656P4V7M/Du9lcTl38Ngm6KszMj7bq4J1IGZwSYR4c95Tv5UQALtYNWUwaI9UT3xw==} + engines: {node: '>=20'} + + '@shikijs/engine-javascript@4.6.0': + resolution: {integrity: sha512-K0oqxFoL+kEMdz89mHLFO15Tsbv3kFZ6WR1cXZKMvLSc+oqaM00A6pyga1qSeXB22dP0tTiSApRcGBaKWsEccg==} + engines: {node: '>=20'} + + '@shikijs/engine-oniguruma@4.6.0': + resolution: {integrity: sha512-aggd6Q7SuJOXNnsUbfG2XesxBJKBMAw/PDTUo9PyRjMaaJJ2dNrI+q0C+25ARXAK9yLHAlwxc9oRT2u68YKZ7w==} + engines: {node: '>=20'} + + '@shikijs/langs@4.6.0': + resolution: {integrity: sha512-1yMEX3oCVV54LUq/ovfpRkDQoYDkcvjSWFFa/YLUDMiSoRzMi2uxLJYbv41ahT8Lu9lFMaa7hecd3Q39trqUyg==} + engines: {node: '>=20'} + + '@shikijs/primitive@4.6.0': + resolution: {integrity: sha512-c54+TQEo9ToqgfL/AU8FpjnV09+GA9Oa7M5ROkkXteZfp5XzpAJGXjjvZQFQioJOwm/w/6Z3lIzQstAkl8coag==} + engines: {node: '>=20'} + + '@shikijs/themes@4.6.0': + resolution: {integrity: sha512-qHAVAs80RiGD+IRuH9G+JPDOEc9A/kHsng4EzCUCwB9bLzW6Z0y9WETh2YyCcADJBmfrIaJ1Jp7KBNP6FHkgtQ==} + engines: {node: '>=20'} + + '@shikijs/types@4.6.0': + resolution: {integrity: sha512-+ENG1adsKt/X7cRYw1Nl7BEpBmPOjmQ7bR/eGmHuMlT8gtOFf3KEi5l31DJYyAWhW6Y6bjP1plU7FmaxWGENFw==} + engines: {node: '>=20'} + + '@shikijs/vscode-textmate@10.1.0': + resolution: {integrity: sha512-cVBuhDQjBZaNMTwBquYfPydrUP+E3hE6oYGasx8h6ZrODIM7/r+gxLDXdd66oszbrggZHEntdE6j+5gYIVyMWQ==} + + '@tybys/wasm-util@0.10.4': + resolution: {integrity: sha512-W3c4gRigFS0T/Ma4qIYF3GDAc5AQdHb1yL5znJT1Zv1YaD9Kitx656wBjvr19qbiosmZT8lWDM5BEMynUqX65A==} + + '@types/debug@4.1.13': + resolution: {integrity: sha512-KSVgmQmzMwPlmtljOomayoR89W4FynCAi3E8PPs7vmDVPe84hT+vGPKkJfThkmXs0x0jAaa9U8uW8bbfyS2fWw==} + + '@types/estree-jsx@1.0.5': + resolution: {integrity: sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSdkuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg==} + + '@types/estree@1.0.10': + resolution: {integrity: sha512-lTyOMnOcmRBzdCv6/4zUZCrEhV0xrqQiUZBZtVcbmLHBXKLnN8q89v/wKRF/Q0HbwVsqbIG3o5HDoFl9sduM+g==} + + '@types/hast@3.0.5': + resolution: {integrity: sha512-rp/ezSWaD1m44dPKICGhiskI13nVr7qTloFwDa/IYkhhf5nzwP+zIQcIJh3WIFSBOy/H1PzB40jPjMDksN4F+g==} + + '@types/mdast@4.0.4': + resolution: {integrity: sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==} + + '@types/mdx@2.0.14': + resolution: {integrity: sha512-T48PeuJtvLosNTPVhfnIp3i/n3a4g4Bad7YCq5k64D4u7NwDrAotikQ+5+sjtUvBmxCMlbo3dVL+C2dP0rWHzg==} + + '@types/ms@2.1.0': + resolution: {integrity: sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==} + + '@types/nlcst@2.0.3': + resolution: {integrity: sha512-vSYNSDe6Ix3q+6Z7ri9lyWqgGhJTmzRjZRqyq15N0Z/1/UnVsno9G/N40NBijoYx2seFDIl0+B2mgAb9mezUCA==} + + '@types/node@26.6.6': + resolution: {integrity: sha512-MzQj+8Kx3XI40OmUAE6Qoh58ZMNstNNMwn2nfd3qWsfe7nDNSqJNzes4njhz6AHwrSHOffSLwXU6yb474Q4aog==} + + '@types/sax@1.2.7': + resolution: {integrity: sha512-rO73L89PJxeYM3s3pPPjiPgVVcymqU490g0YO5n5By0k2Erzj6tay/4lr1CHAAU4JyOWd1rpQ8bCf6cZfHU96A==} + + '@types/unist@2.0.11': + resolution: {integrity: sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA==} + + '@types/unist@3.0.3': + resolution: {integrity: sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==} + + '@ungap/structured-clone@1.4.0': + resolution: {integrity: sha512-1mEZtMKPM09vDmQt5y7YvmN2+DFTP7Tg0EWXdic8/C6VRnpb33e4ghisCIE3WZjsE2N8mf+QV1Zqh7ZFYLWInQ==} + + acorn-jsx@5.3.2: + resolution: {integrity: sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==} + peerDependencies: + acorn: ^6.0.0 || ^7.0.0 || ^8.0.0 + + acorn@8.19.0: + resolution: {integrity: sha512-oJlA3XiRm7Cyk6qFD2Jn8ak9B7jSy0qy00ADO3+8dpT0LSjFihQYv4C02LFCSYJV3Q37xYwwRy5m+IpIiUzqWw==} + engines: {node: '>=0.4.0'} + hasBin: true + + am-i-vibing@0.5.0: + resolution: {integrity: sha512-KLcsDhqf1XRrJmJr+9I/C0EX2K+sGrAGZFgkmd84c8TJO9zJBu+/kFInjazu1KfJWFhWDKdRWkpBzEs7s35DVA==} + hasBin: true + + ansi-escapes@7.3.0: + resolution: {integrity: sha512-BvU8nYgGQBxcmMuEeUEmNTvrMVjJNSH7RgW24vXexN4Ven6qCvy4TntnvlnwnMLTVlcRQQdbRY8NKnaIoeWDNg==} + engines: {node: '>=18'} + + anymatch@3.1.3: + resolution: {integrity: sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==} + engines: {node: '>= 8'} + + aria-query@5.3.2: + resolution: {integrity: sha512-COROpnaoap1E2F000S62r6A60uHZnmlvomhfyT2DlTcrY1OrBKn2UhH7qn5wTC9zMvD0AY7csdPSNwKP+7WiQw==} + engines: {node: '>= 0.4'} + + array-iterate@2.0.1: + resolution: {integrity: sha512-I1jXZMjAgCMmxT4qxXfPXa6SthSoE8h6gkSI9BGGNv8mP8G/v0blc+qFnZu6K42vTOiuME596QaLO0TP3Lk0xg==} + + astring@1.9.0: + resolution: {integrity: sha512-LElXdjswlqjWrPpJFg1Fx4wpkOCxj1TDHlSV4PlaRxHGWko024xICaa97ZkMfs6DRKlCguiAI+rbXv5GWwXIkg==} + hasBin: true + + astro-expressive-code@0.44.3: + resolution: {integrity: sha512-LUpQmmvzr90JXP5QIAopgdjlOKLuT3x0wlPAUpc4OZtPtFS8sbflPcGPpL/lG3pQuUCQV2CXUFgYNBYNu9tphA==} + peerDependencies: + astro: ^4.0.0-beta || ^5.0.0-beta || ^3.3.0 || ^6.0.0-beta || ^7.0.0 + + astro@7.4.12: + resolution: {integrity: sha512-DKX+Ds0rqV49HrLwEB9JFrCyfvQeC16FCe1HrPK8S3osiJH/e2vQ22CHIDOpI48UaeiPbxPT26peXgGTy6w0ig==} + engines: {node: '>=22.23.4', npm: '>=9.6.5', pnpm: '>=7.1.0'} + hasBin: true + peerDependencies: + '@astrojs/markdown-remark': ^7.3.0 + peerDependenciesMeta: + '@astrojs/markdown-remark': + optional: true + + axobject-query@4.1.0: + resolution: {integrity: sha512-qIj0G9wZbMGNLjLmg1PT6v2mE9AH2zlnADJD/2tC6E00hgmhUOfEB6greHPAfLRSufHqROIUTkw6E+M3lH0PTQ==} + engines: {node: '>= 0.4'} + + bail@2.0.2: + resolution: {integrity: sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw==} + + bcp-47-match@2.0.3: + resolution: {integrity: sha512-JtTezzbAibu8G0R9op9zb3vcWZd9JF6M0xOYGPn0fNCd7wOpRB1mU2mH9T8gaBGbAAyIIVgB2G7xG0GP98zMAQ==} + + bcp-47@2.1.2: + resolution: {integrity: sha512-wsv86UuNFuPnVieKLyECTT+CP1WSAHeoIg5P3xu2kA9Z+7fVPoKt7dxzSeEhtJel0AI+NW3fIW3KtTKQKUCngg==} + + boolbase@1.0.0: + resolution: {integrity: sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww==} + + ccount@2.0.1: + resolution: {integrity: sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==} + + character-entities-html4@2.1.0: + resolution: {integrity: sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==} + + character-entities-legacy@3.0.0: + resolution: {integrity: sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==} + + character-entities@2.0.2: + resolution: {integrity: sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ==} + + character-reference-invalid@2.0.1: + resolution: {integrity: sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw==} + + chokidar@5.0.0: + resolution: {integrity: sha512-TQMmc3w+5AxjpL8iIiwebF73dRDF4fBIieAqGn9RGCWaEVwQ6Fb2cGe31Yns0RRIzii5goJ1Y7xbMwo1TxMplw==} + engines: {node: '>= 20.19.0'} + + ci-info@4.5.0: + resolution: {integrity: sha512-d1uM8k5UZEyPza1n/MG3ko8nKupKN0KJpFsipgPcgaCCvV+IqIfJ+NzTjetlLM+UcXZx3+cLrNr76+eAO7G1Mw==} + engines: {node: '>=8'} + + clsx@2.1.1: + resolution: {integrity: sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA==} + engines: {node: '>=6'} + + collapse-white-space@2.1.0: + resolution: {integrity: sha512-loKTxY1zCOuG4j9f6EPnuyyYkf58RnhhWTvRoZEokgB+WbdXehfjFviyOVYkqzEWz1Q5kRiZdBYS5SwxbQYwzw==} + + comma-separated-tokens@2.0.3: + resolution: {integrity: sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==} + + commander@11.1.0: + resolution: {integrity: sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==} + engines: {node: '>=16'} + + common-ancestor-path@2.0.0: + resolution: {integrity: sha512-dnN3ibLeoRf2HNC+OlCiNc5d2zxbLJXOtiZUudNFSXZrNSydxcCsSpRzXwfu7BBWCIfHPw+xTayeBvJCP/D8Ng==} + engines: {node: '>= 18'} + + cookie-es@1.2.3: + resolution: {integrity: sha512-lXVyvUvrNXblMqzIRrxHb57UUVmqsSWlxqt3XIjCkUP0wDAf6uicO6KMbEgYrMNtEvWgWHwe42CKxPu9MYAnWw==} + + cookie@2.0.2: + resolution: {integrity: sha512-SL0cVuEdETEp7pN0FuZb01toc3vnODEfVUCooxG1SJN0yIirh7JMb9X9bvfCFf0vzzbT68RdbKDHYTiWy7a7iw==} + engines: {node: '>=22'} + + crossws@0.3.5: + resolution: {integrity: sha512-ojKiDvcmByhwa8YYqbQI/hg7MEU0NC03+pSdEq4ZUnZR9xXpwk7E43SMNGkn+JxJGPFtNvQ48+vV2p+P1ml5PA==} + + css-select@6.0.0: + resolution: {integrity: sha512-rZZVSLle8v0+EY8QAkDWrKhpgt6SA5OtHsgBnsj6ZaLb5dmDVOWUDtQitd9ydxxvEjhewNudS6eTVU7uOyzvXw==} + + css-selector-parser@3.3.0: + resolution: {integrity: sha512-Y2asgMGFqJKF4fq4xHDSlFYIkeVfRsm69lQC1q9kbEsH5XtnINTMrweLkjYMeaUgiXBy/uvKeO/a1JHTNnmB2g==} + + css-tree@2.2.1: + resolution: {integrity: sha512-OA0mILzGc1kCOCSJerOeqDxDQ4HOh+G8NbOJFOTgOCzpw7fCBubk0fEyxp8AgOL/jvLgYA/uV0cMbe43ElF1JA==} + engines: {node: ^10 || ^12.20.0 || ^14.13.0 || >=15.0.0, npm: '>=7.0.0'} + + css-tree@3.2.1: + resolution: {integrity: sha512-X7sjQzceUhu1u7Y/ylrRZFU2FS6LRiFVp6rKLPg23y3x3c3DOKAwuXGDp+PAGjh6CSnCjYeAul8pcT8bAl+lSA==} + engines: {node: ^10 || ^12.20.0 || ^14.13.0 || >=15.0.0} + + css-what@7.0.0: + resolution: {integrity: sha512-wD5oz5xibMOPHzy13CyGmogB3phdvcDaB5t0W/Nr5Z2O/agcB8YwOz6e2Lsp10pNDzBoDO9nVa3RGs/2BttpHQ==} + engines: {node: '>= 6'} + + csso@5.0.5: + resolution: {integrity: sha512-0LrrStPOdJj+SPCCrGhzryycLjwcgUSHBtxNA8aIDxf0GLsRh1cKYhB00Gd1lDOS4yGH69+SNn13+TWbVHETFQ==} + engines: {node: ^10 || ^12.20.0 || ^14.13.0 || >=15.0.0, npm: '>=7.0.0'} + + debug@4.4.3: + resolution: {integrity: sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==} + engines: {node: '>=6.0'} + peerDependencies: + supports-color: '*' + peerDependenciesMeta: + supports-color: + optional: true + + decode-named-character-reference@1.3.0: + resolution: {integrity: sha512-GtpQYB283KrPp6nRw50q3U9/VfOutZOe103qlN7BPP6Ad27xYnOIWv4lPzo8HCAL+mMZofJ9KEy30fq6MfaK6Q==} + + defu@6.1.7: + resolution: {integrity: sha512-7z22QmUWiQ/2d0KkdYmANbRUVABpZ9SNYyH5vx6PZ+nE5bcC0l7uFvEfHlyld/HcGBFTL536ClDt3DEcSlEJAQ==} + + dequal@2.0.3: + resolution: {integrity: sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==} + engines: {node: '>=6'} + + destr@2.0.5: + resolution: {integrity: sha512-ugFTXCtDZunbzasqBxrK93Ik/DRYsO6S/fedkWEMKqt04xZ4csmnmwGDBAb07QWNaGMAmnTIemsYZCksjATwsA==} + + detect-libc@2.1.2: + resolution: {integrity: sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ==} + engines: {node: '>=8'} + + devalue@6.0.3: + resolution: {integrity: sha512-3woMEITftG1wKeO/4d/QXH1DVKctTSZg3jNGPpjp9hNr5Hos8MCFF5McTML5ZtgKDObm2R591B0spRp2IVernA==} + engines: {node: '>=18'} + + devlop@1.1.0: + resolution: {integrity: sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==} + + diff@9.0.0: + resolution: {integrity: sha512-svtcdpS8CgJyqAjEQIXdb3OjhFVVYjzGAPO8WGCmRbrml64SPw/jJD4GoE98aR7r25A0XcgrK3F02yw9R/vhQw==} + engines: {node: '>=0.3.1'} + + direction@2.0.1: + resolution: {integrity: sha512-9S6m9Sukh1cZNknO1CWAr2QAWsbKLafQiyM5gZ7VgXHeuaoUwffKN4q6NC4A/Mf9iiPlOXQEKW/Mv/mh9/3YFA==} + hasBin: true + + dom-serializer@2.0.0: + resolution: {integrity: sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==} + + domelementtype@2.3.0: + resolution: {integrity: sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==} + + domhandler@5.0.3: + resolution: {integrity: sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==} + engines: {node: '>= 4'} + + domutils@3.2.2: + resolution: {integrity: sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw==} + + dset@3.1.4: + resolution: {integrity: sha512-2QF/g9/zTaPDc3BjNcVTGoBbXBgYfMTTceLaYcFJ/W9kggFUkhxD/hMEeuLKbugyef9SqAx8cpgwlIP/jinUTA==} + engines: {node: '>=4'} + + entities@4.5.0: + resolution: {integrity: sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==} + engines: {node: '>=0.12'} + + entities@9.0.0: + resolution: {integrity: sha512-oJFNDJg3kTPwAD1cNn2+WmUq4wFoo09npc3Ydf1D7ED4smRiWrsKnaLxykrTWgyGEcusc87P5dxlAleol9kpkg==} + engines: {node: '>=20.19.0'} + + environment@1.1.0: + resolution: {integrity: sha512-xUtoPkMggbz0MPyPiIWr1Kp4aeWJjDZ6SMvURhimjdZgsRuDplF5/s9hcgGhyXMhs+6vpnuoiZ2kFiu3FMnS8Q==} + engines: {node: '>=18'} + + es-module-lexer@3.0.4: + resolution: {integrity: sha512-BldNY5mwkVu+cQ5Ymn3e6hB9Sx8XHx4ZevWbiUyZbfKxJxYO27Hf0wfzkxIaD5CAJMaGl3YspKELj0ff/7nCMA==} + + esast-util-from-estree@2.0.0: + resolution: {integrity: sha512-4CyanoAudUSBAn5K13H4JhsMH6L9ZP7XbLVe/dKybkxMO7eDyLsT8UHl9TRNrU2Gr9nz+FovfSIjuXWJ81uVwQ==} + + esast-util-from-js@2.0.1: + resolution: {integrity: sha512-8Ja+rNJ0Lt56Pcf3TAmpBZjmx8ZcK5Ts4cAzIOjsjevg9oSXJnl6SUQ2EevU8tv3h6ZLWmoKL5H4fgWvdvfETw==} + + escape-string-regexp@5.0.0: + resolution: {integrity: sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==} + engines: {node: '>=12'} + + estree-util-attach-comments@3.0.0: + resolution: {integrity: sha512-cKUwm/HUcTDsYh/9FgnuFqpfquUbwIqwKM26BVCGDPVgvaCl/nDCCjUfiLlx6lsEZ3Z4RFxNbOQ60pkaEwFxGw==} + + estree-util-build-jsx@3.0.1: + resolution: {integrity: sha512-8U5eiL6BTrPxp/CHbs2yMgP8ftMhR5ww1eIKoWRMlqvltHF8fZn5LRDvTKuxD3DUn+shRbLGqXemcP51oFCsGQ==} + + estree-util-is-identifier-name@3.0.0: + resolution: {integrity: sha512-hFtqIDZTIUZ9BXLb8y4pYGyk6+wekIivNVTcmvk8NoOh+VeRn5y6cEHzbURrWbfp1fIqdVipilzj+lfaadNZmg==} + + estree-util-scope@1.0.1: + resolution: {integrity: sha512-B0np3dcdxqILX5e9nEi5/Fr4K7gL4oYFVPV1zRa2e9wRCbQoZZNWOZFYyoInvXUPJXBXjss+QXlWLJChDEHDkA==} + + estree-util-to-js@2.0.0: + resolution: {integrity: sha512-WDF+xj5rRWmD5tj6bIqRi6CkLIXbbNQUcxQHzGysQzvHmdYG2G7p/Tf0J0gpxGgkeMZNTIjT/AoSvC9Xehcgdg==} + + estree-util-visit@2.0.0: + resolution: {integrity: sha512-m5KgiH85xAhhW8Wta0vShLcUvOsh3LLPI2YVwcbio1l7E09NTLL1EyMZFM1OyWowoH0skScNbhOPl4kcBgzTww==} + + estree-walker@3.0.3: + resolution: {integrity: sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==} + + expressive-code@0.44.3: + resolution: {integrity: sha512-7RGslhJTNt01pdn5I3QmVh5C8ZIiSm0A+ORQ9j9r39oOgJVKjn/7dXl9rMT/SqmFLE6pJkTYI7UjW0BxJnW7OQ==} + + extend@3.0.2: + resolution: {integrity: sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==} + + fast-string-truncated-width@3.0.3: + resolution: {integrity: sha512-0jjjIEL6+0jag3l2XWWizO64/aZVtpiGE3t0Zgqxv0DPuxiMjvB3M24fCyhZUO4KomJQPj3LTSUnDP3GpdwC0g==} + + fast-string-width@3.0.2: + resolution: {integrity: sha512-gX8LrtNEI5hq8DVUfRQMbr5lpaS4nMIWV+7XEbXk2b8kiQIizgnlr12B4dA3ZEx3308ze0O4Q1R+cHts8kyUJg==} + + fast-wrap-ansi@0.2.2: + resolution: {integrity: sha512-7F2Fl+TjRSenLqlU3UjSH0iyqopqoZIu7eZVpEirP2g1GtWa2G/ecEmBdgz31+Mxr+ELclgg6sokpSFIQiZ02Q==} + + fdir@6.5.0: + resolution: {integrity: sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==} + engines: {node: '>=12.0.0'} + peerDependencies: + picomatch: ^3 || ^4 + peerDependenciesMeta: + picomatch: + optional: true + + flattie@1.1.1: + resolution: {integrity: sha512-9UbaD6XdAL97+k/n+N7JwX46K/M6Zc6KcFYskrYL8wbBV/Uyk0CTAMY0VT+qiK5PM7AIc9aTWYtq65U7T+aCNQ==} + engines: {node: '>=8'} + + fnv1a-64@0.1.2: + resolution: {integrity: sha512-mJbcILTPybAR1jdOwt/lVv8N2cffeJFFP+gVbSAwLEx1ujXH27RpPd8Rokec/KX9c76UYIB6Co+H4lQzxPnJfA==} + + fontace@0.4.1: + resolution: {integrity: sha512-lDMvbAzSnHmbYMTEld5qdtvNH2/pWpICOqpean9IgC7vUbUJc3k+k5Dokp85CegamqQpFbXf0rAVkbzpyTA8aw==} + + fontkitten@1.0.3: + resolution: {integrity: sha512-Wp1zXWPVUPBmfoa3Cqc9ctaKuzKAV6uLstRqlR56kSjplf5uAce+qeyYym7F+PHbGTk+tCEdkCW6RD7DX/gBZw==} + engines: {node: '>=20'} + + fsevents@2.3.3: + resolution: {integrity: sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==} + engines: {node: ^8.16.0 || ^10.6.0 || >=11.0.0} + os: [darwin] + + get-tsconfig@5.0.0-beta.6: + resolution: {integrity: sha512-X6fBC0pmImC70gvX2zm56go9hx0MyoGVdG0tUCkg/D+Xnh5TJsOZ7iDbOdI3PvmtrDxnu1YdDufpK2QJX1Meqw==} + engines: {node: '>=20.20.0'} + + github-slugger@2.0.0: + resolution: {integrity: sha512-IaOQ9puYtjrkq7Y0Ygl9KDZnrf/aiUJYUpVf89y8kyaxbRG7Y1SrX/jaumrv81vc61+kiMempujsM3Yw7w5qcw==} + + h3@1.15.11: + resolution: {integrity: sha512-L3THSe2MPeBwgIZVSH5zLdBBU90TOxarvhK9d04IDY2AmVS8j2Jz2LIWtwsGOU3lu2I5jCN7FNvVfY2+XyF+mg==} + + has-flag@5.0.1: + resolution: {integrity: sha512-CsNUt5x9LUdx6hnk/E2SZLsDyvfqANZSUq4+D3D8RzDJ2M+HDTIkF60ibS1vHaK55vzgiZw1bEPFG9yH7l33wA==} + engines: {node: '>=12'} + + hast-util-embedded@3.0.0: + resolution: {integrity: sha512-naH8sld4Pe2ep03qqULEtvYr7EjrLK2QHY8KJR6RJkTUjPGObe1vnx585uzem2hGra+s1q08DZZpfgDVYRbaXA==} + + hast-util-format@1.1.0: + resolution: {integrity: sha512-yY1UDz6bC9rDvCWHpx12aIBGRG7krurX0p0Fm6pT547LwDIZZiNr8a+IHDogorAdreULSEzP82Nlv5SZkHZcjA==} + + hast-util-from-html@2.1.0: + resolution: {integrity: sha512-873p9AuH93gBnATbH8rU3YvjTKxyrIeWd/M9tiLMzn3G82Os0xhQurctfnbYUSrDXoyjbJGpJ2qmTpefMw7ZaQ==} + + hast-util-from-parse5@8.0.4: + resolution: {integrity: sha512-Yq7XlXor0Cpb71sI2E0zpv8QxQ5a6rfhDEETk4bcgrFX2SvJAY2PHocWwFtL6U9qyfiyByW3wZ6sZEfP2kW81g==} + + hast-util-has-property@3.0.0: + resolution: {integrity: sha512-MNilsvEKLFpV604hwfhVStK0usFY/QmM5zX16bo7EjnAEGofr5YyI37kzopBlZJkHD4t887i+q/C8/tr5Q94cA==} + + hast-util-is-body-ok-link@3.0.1: + resolution: {integrity: sha512-0qpnzOBLztXHbHQenVB8uNuxTnm/QBFUOmdOSsEn7GnBtyY07+ENTWVFBAnXd/zEgd9/SUG3lRY7hSIBWRgGpQ==} + + hast-util-is-element@3.0.0: + resolution: {integrity: sha512-Val9mnv2IWpLbNPqc/pUem+a7Ipj2aHacCwgNfTiK0vJKl0LF+4Ba4+v1oPHFpf3bLYmreq0/l3Gud9S5OH42g==} + + hast-util-minify-whitespace@1.0.1: + resolution: {integrity: sha512-L96fPOVpnclQE0xzdWb/D12VT5FabA7SnZOUMtL1DbXmYiHJMXZvFkIZfiMmTCNJHUeO2K9UYNXoVyfz+QHuOw==} + + hast-util-parse-selector@4.0.0: + resolution: {integrity: sha512-wkQCkSYoOGCRKERFWcxMVMOcYE2K1AaNLU8DXS9arxnLOUEWbOXKXiJUNzEpqZ3JOKpnha3jkFrumEjVliDe7A==} + + hast-util-phrasing@3.0.1: + resolution: {integrity: sha512-6h60VfI3uBQUxHqTyMymMZnEbNl1XmEGtOxxKYL7stY2o601COo62AWAYBQR9lZbYXYSBoxag8UpPRXK+9fqSQ==} + + hast-util-raw@9.2.0: + resolution: {integrity: sha512-1zVq3M9AlZiBZ4mlMPnLtkK2rdd+I8VhmFLNLb//XJm6xA2AVH2tz19EHy25RgRWut6z6FpTARAs7P8rnmRJUQ==} + + hast-util-select@6.0.4: + resolution: {integrity: sha512-RqGS1ZgI0MwxLaKLDxjprynNzINEkRHY2i8ln4DDjgv9ZhcYVIHN9rlpiYsqtFwrgpYU361SyWDQcGNIBVu3lw==} + + hast-util-to-estree@3.1.3: + resolution: {integrity: sha512-48+B/rJWAp0jamNbAAf9M7Uf//UVqAoMmgXhBdxTDJLGKY+LRnZ99qcG+Qjl5HfMpYNzS5v4EAwVEF34LeAj7w==} + + hast-util-to-html@9.0.6: + resolution: {integrity: sha512-1SZUxCN3TtJAE7e2BQN2MBHsoZ1gnmi9GoCP5Di59CSWptIezSAW09yDZyVbanb78V9eCwrKqdQsjtfVTxYHWA==} + + hast-util-to-jsx-runtime@2.3.7: + resolution: {integrity: sha512-F7DNV2NMcTxA4GqPVHnXzX+mpoPHAIY9rJAVH3CZ1FdBZOcBUEjUuvMkMpHVs/sicEtznh9tMGj5WUR9S4E2rg==} + + hast-util-to-parse5@8.0.1: + resolution: {integrity: sha512-MlWT6Pjt4CG9lFCjiz4BH7l9wmrMkfkJYCxFwKQic8+RTZgWPuWxwAfjJElsXkex7DJjfSJsQIt931ilUgmwdA==} + + hast-util-to-string@3.0.1: + resolution: {integrity: sha512-XelQVTDWvqcl3axRfI0xSeoVKzyIFPwsAGSLIsKdJKQMXDYJS4WYrBNF/8J7RdhIcFI2BOHgAifggsvsxp/3+A==} + + hast-util-to-text@4.0.3: + resolution: {integrity: sha512-5yrlWOvGFs6CqHriUpSsNrjzT/Tdo+IOQudbznxOn8K5qblp18MJyzOg8IgDOKQ8MYgQcJA7SusuCjSpDr8mSA==} + + hast-util-whitespace@3.0.0: + resolution: {integrity: sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==} + + hastscript@9.0.3: + resolution: {integrity: sha512-1ALZXSmCGmW3h8AMz4R4+QKSKFi7sNgXLVwmwB8FYVtl1CwQ3WDkSAEY/d5tp1g/vbQgq2s1WlHgfO3jbw1TsA==} + + html-escaper@3.0.3: + resolution: {integrity: sha512-RuMffC89BOWQoY0WKGpIhn5gX3iI54O6nRA0yC124NYVtzjmFWBIiFd8M0x+ZdX0P9R4lADg1mgP8C7PxGOWuQ==} + + html-void-elements@3.0.0: + resolution: {integrity: sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==} + + html-whitespace-sensitive-tag-names@3.0.1: + resolution: {integrity: sha512-q+310vW8zmymYHALr1da4HyXUQ0zgiIwIicEfotYPWGN0OJVEN/58IJ3A4GBYcEq3LGAZqKb+ugvP0GNB9CEAA==} + + http-cache-semantics@4.3.0: + resolution: {integrity: sha512-M5t5LlJpS1UHMjvwRQVdFHvPISGeLAxNcrWuJkeGh0KxsqCHZ1O3NXZU/8x7cD0BDcGW8kapxMKTvwlqrNkHkA==} + + i18next@27.1.2: + resolution: {integrity: sha512-851D6dY9vuhn9hF0p5KpY7FPeYnm3P73tqyX2nxfsjeEYVg7Du0Fflw0rJtv7nFnZcDQS0+Hqn0UP6+SPx8mew==} + engines: {node: '>=22'} + peerDependencies: + typescript: ^5 || ^6 || ^7 + peerDependenciesMeta: + typescript: + optional: true + + inline-style-parser@0.2.7: + resolution: {integrity: sha512-Nb2ctOyNR8DqQoR0OwRG95uNWIC0C1lCgf5Naz5H6Ji72KZ8OcFZLz2P5sNgwlyoJ8Yif11oMuYs5pBQa86csA==} + + inline-style-parser@0.2.9: + resolution: {integrity: sha512-IttN8BqKLxzUrnTqHI+/hwAJQItBAUjdoHERCDv+oOuX48VP6bzW8+QjOXSfoevzq3YrYAwX1uLHp8TqO9yIeg==} + + iron-webcrypto@1.2.1: + resolution: {integrity: sha512-feOM6FaSr6rEABp/eDfVseKyTMDt+KGpeB35SkVn9Tyn0CqvVsY3EwI0v5i8nMHyJnzCIQf7nsy3p41TPkJZhg==} + + is-absolute-url@5.0.0: + resolution: {integrity: sha512-sdJyNpBnQHuVnBunfzjAecOhZr2+A30ywfFvu3EnxtKLUWfwGgyWUmqHbGZiU6vTfHpCPm5GvLe4BAvlU9n8VQ==} + engines: {node: '>=20'} + + is-alphabetical@2.0.1: + resolution: {integrity: sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ==} + + is-alphanumerical@2.0.1: + resolution: {integrity: sha512-hmbYhX/9MUMF5uh7tOXyK/n0ZvWpad5caBA17GsC6vyuCqaWliRG5K1qS9inmUhEMaOBIW7/whAnSwveW/LtZw==} + + is-decimal@2.0.1: + resolution: {integrity: sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A==} + + is-docker@4.0.0: + resolution: {integrity: sha512-LHE+wROyG/Y/0ZnbktRCoTix2c1RhgWaZraMZ8o1Q7zCh0VSrICJQO5oqIIISrcSBtrXv0o233w1IYwsWCjTzA==} + engines: {node: '>=20'} + hasBin: true + + is-hexadecimal@2.0.1: + resolution: {integrity: sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg==} + + is-plain-obj@4.1.0: + resolution: {integrity: sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg==} + engines: {node: '>=12'} + + jsonc-parser@3.3.1: + resolution: {integrity: sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==} + + klona@2.0.6: + resolution: {integrity: sha512-dhG34DXATL5hSxJbIexCft8FChFXtmskoZYnoPWjXQuebWYCNkVeV3KkGegCK9CP1oswI/vQibS2GY7Em/sJJA==} + engines: {node: '>= 8'} + + lightningcss-android-arm64@1.33.0: + resolution: {integrity: sha512-gEpRTalKdosp4Bb8qWtc2iOgE5SeIHlpS1up9bFq2wAyYhl1UdTObYiHe98zEM9SQvSoqQZ1IQD0JNpg3Ml5pg==} + engines: {node: '>= 12.0.0'} + cpu: [arm64] + os: [android] + + lightningcss-darwin-arm64@1.33.0: + resolution: {integrity: sha512-Sciaz8eenNTKn9b3t7+xr0ipTp9YxKQY4npwQ3mrRuL0BAVHBLyZxofhaKBAVtzmtRZ/zTyo0/to4B1uWG/Djg==} + engines: {node: '>= 12.0.0'} + cpu: [arm64] + os: [darwin] + + lightningcss-darwin-x64@1.33.0: + resolution: {integrity: sha512-Z5UPAxzrjlWNNyGy6i65cJzzvgJ5D3T6wMvs+gWpY9d7qRhANrxqAp6LhxIgZhWEw18RfJTGcRxjuLIBr+m8XQ==} + engines: {node: '>= 12.0.0'} + cpu: [x64] + os: [darwin] + + lightningcss-freebsd-x64@1.33.0: + resolution: {integrity: sha512-QQM/Ti/hQajJwCY+RiWuCZ9sdtI/XQk7nDK5vC8kkdwixezOlDgvDx7+RT+QjK6FcFT4MpsuoBnHIo/O3StRRg==} + engines: {node: '>= 12.0.0'} + cpu: [x64] + os: [freebsd] + + lightningcss-linux-arm-gnueabihf@1.33.0: + resolution: {integrity: sha512-N7FVBe6iS24MlM6R/4RBTxGhQheZGs7tiQ9U32UtF75NzP5Q7xWPRqLBCKxlRQRk3rY1jCIPLzx7WzOhuUIRLQ==} + engines: {node: '>= 12.0.0'} + cpu: [arm] + os: [linux] + + lightningcss-linux-arm64-gnu@1.33.0: + resolution: {integrity: sha512-j2v/itmy4HlNxlc6voKXYgBqNi0Ng2LShg4z7GufpEgs05P+2suBVyi9I6YHq5uoVFx9ETin3eCEhLVyXGQnKg==} + engines: {node: '>= 12.0.0'} + cpu: [arm64] + os: [linux] + libc: [glibc] + + lightningcss-linux-arm64-musl@1.33.0: + resolution: {integrity: sha512-yiO5ROMuYQgXbC60yjZU5CYSFZGKXL0HFATXt9mHJn1+zW55oCtMI9NfcVhYLMFDL7gV7oBPon/EmMMGg2OvtQ==} + engines: {node: '>= 12.0.0'} + cpu: [arm64] + os: [linux] + libc: [musl] + + lightningcss-linux-x64-gnu@1.33.0: + resolution: {integrity: sha512-ar+Ju7LmcN0Jo4FpL4hpFybwNG9/3A/Br5KW2n2jyODg3MEZXaDYADdemoNS+BDNfMgKvylJLj4S5tyRActuAg==} + engines: {node: '>= 12.0.0'} + cpu: [x64] + os: [linux] + libc: [glibc] + + lightningcss-linux-x64-musl@1.33.0: + resolution: {integrity: sha512-RYiYbkokw0trfKqqzfF55lginwEPrD3OJDfTuJzFs1MK6iFnDenaz1fqLLtX4ITG3OktJQXOeTaw1awrBAlZPw==} + engines: {node: '>= 12.0.0'} + cpu: [x64] + os: [linux] + libc: [musl] + + lightningcss-win32-arm64-msvc@1.33.0: + resolution: {integrity: sha512-1K+MPfLSFVpphzpdbfkhlWk6wBrTObBzS2T6db10PNOZgR9GoVsAWzwNyuhUYYbTp23j+4RrncfujZ4uAzXvwA==} + engines: {node: '>= 12.0.0'} + cpu: [arm64] + os: [win32] + + lightningcss-win32-x64-msvc@1.33.0: + resolution: {integrity: sha512-OlEICDx/Xl0FqSp4bry8zFnCvGpig3Gl4gCquvYwHuqJKEC1+n9NgDniFvqHGmMv1ZkqDJrDqKKSykTDX+ehuA==} + engines: {node: '>= 12.0.0'} + cpu: [x64] + os: [win32] + + lightningcss@1.33.0: + resolution: {integrity: sha512-WkUDrojuJs0xkgGf2udWxa3yGBRxPtxUkB79i6aCZLRgc7PM8fZe9TosfPDcvEpQZbuFASnHYmRLBLUbmLOIIA==} + engines: {node: '>= 12.0.0'} + + longest-streak@3.1.0: + resolution: {integrity: sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g==} + + lru-cache@11.5.3: + resolution: {integrity: sha512-U4N8FgzmWxc8k1VH8Kr6lQg18U7Fjvby6wXHVRX/ZZ7IwWbRMgrRbP0Wrb5q5NVinryp4SQampHKdvtecItxUg==} + engines: {node: 20 || >=22} + + magic-string@1.4.5: + resolution: {integrity: sha512-oLLC2+YvQUfAa+vxoufE/yc1icb87M9iXIRqAoR/2EhE/8cb3SF/+Gi0c2By1B+5Vz2e2vQtUvHiu1+63Znh+w==} + + magicast@0.5.5: + resolution: {integrity: sha512-UicdXN8zQ3JHlxVq+28afMXPr1z7WNY6+7EJnzTdQWkTAlMLF5fNCCKxJHBQwGaNGR11581EiQmQzx73+MvszA==} + + markdown-extensions@2.0.0: + resolution: {integrity: sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q==} + engines: {node: '>=16'} + + markdown-table@3.1.0: + resolution: {integrity: sha512-xpeSCdM+B+6P3ncfgaB7FoDbtJ30xAe6Z18TGT7AgXJsHqCElCICZovQqdRMm7kHgpTyYv36EupqewoFFSB8vw==} + + mdast-util-definitions@6.0.0: + resolution: {integrity: sha512-scTllyX6pnYNZH/AIp/0ePz6s4cZtARxImwoPJ7kS42n+MnVsI4XbnG6d4ibehRIldYMWM2LD7ImQblVhUejVQ==} + + mdast-util-directive@3.2.0: + resolution: {integrity: sha512-Yxq+hH4pBEmtaLIJyMVcNbtBiCIKzdOK3HvDeM+JAqC8XVAT1e5PUYbHBpwFvQLIJuJfO2zCu7aNUXWoyZLmhw==} + + mdast-util-find-and-replace@3.0.4: + resolution: {integrity: sha512-z4B5c6jrnJ1ltOQemhWYPBSAo6y42Z8Gt2yEgfgNTMcLSU59B8bfj8Z8AnAlJrBGLnqkdAUZ7jdDEqQw3KuipQ==} + + mdast-util-from-markdown@2.1.0: + resolution: {integrity: sha512-KRLgmPaP2H1ul2bpoJkOS+9pAcDAAj9Nu1mqLnh8NLeJG5tlvj42TH80PIGBpROWlRXLk0lDrWNuZCFy/tsB4A==} + + mdast-util-gfm-autolink-literal@2.1.0: + resolution: {integrity: sha512-Jx6QSK8wDo558Bcf7q+1pe0v81g2PVs09Hlvu9xJHmCFRF3sAPW7vXFVIAwBncs3sde92WbsVqNxwdqViA2XnQ==} + + mdast-util-gfm-footnote@2.1.0: + resolution: {integrity: sha512-sqpDWlsHn7Ac9GNZQMeUzPQSMzR6Wv0WKRNvQRg0KqHh02fpTz69Qc1QSseNX29bhz1ROIyNyxExfawVKTm1GQ==} + + mdast-util-gfm-strikethrough@2.0.1: + resolution: {integrity: sha512-OuJHqvr455pwu2OaOrir7dbzqs4jlWKOtlu9L6GjcIjjQwNyw02VntQsr/Ek6/A13vgnXfUhBekWRUP1OkNivw==} + + mdast-util-gfm-table@2.0.1: + resolution: {integrity: sha512-fiIjPrAy4kz68/eFbPHhsiWDGHhqUSVoU1XsfLM5DsEPXw7MxgiVVyulUggFRckVWeT1KXQXkg5vm3kv4oMSOA==} + + mdast-util-gfm-task-list-item@2.0.1: + resolution: {integrity: sha512-jXVO1hvB2hs82g1esi7I9nIJDqiijbQLIyH2jDUb5s7jIAZMr/79h0VHSq7XHKTqpLARRm+DDNjduB7S9+6XZA==} + + mdast-util-gfm@3.1.0: + resolution: {integrity: sha512-0ulfdQOM3ysHhCJ1p06l0b0VKlhU0wuQs3thxZQagjcjPrlFRqY215uZGHHJan9GEAXd9MbfPjFJz+qMkVR6zQ==} + + mdast-util-mdx-expression@2.0.1: + resolution: {integrity: sha512-J6f+9hUp+ldTZqKRSg7Vw5V6MqjATc+3E4gf3CFNcuZNWD8XdyI6zQ8GqH7f8169MM6P7hMBRDVGnn7oHB9kXQ==} + + mdast-util-mdx-jsx@3.2.1: + resolution: {integrity: sha512-oXp1GIa+E9IwIs3a106+tr3Bz2MlTTBvlXjOZMoIat11kk7vjqgmBnksB9WHmWv+gZh7k3IUgpAHlwHB7DH4GQ==} + + mdast-util-mdx@3.0.0: + resolution: {integrity: sha512-JfbYLAW7XnYTTbUsmpu0kdBUVe+yKVJZBItEjwyYJiDJuZ9w4eeaqks4HQO+R7objWgS2ymV60GYpI14Ug554w==} + + mdast-util-mdxjs-esm@2.0.1: + resolution: {integrity: sha512-EcmOpxsZ96CvlP03NghtH1EsLtr0n9Tm4lPUJUBccV9RwUOneqSycg19n5HGzCf+10LozMRSObtVr3ee1WoHtg==} + + mdast-util-phrasing@4.1.0: + resolution: {integrity: sha512-TqICwyvJJpBwvGAMZjj4J2n0X8QWp21b9l0o7eXyVJ25YNWYbJDVIyD1bZXE6WtV6RmKJVYmQAKWa0zWOABz2w==} + + mdast-util-to-hast@13.2.2: + resolution: {integrity: sha512-l2pnmOuqs+SGLVpTVXnRLQu5v1AzvDe181404fbXzzqObVxrAnnVxapAP27pUwzLBL/ABIkgUhGlPVU7QSvIFg==} + + mdast-util-to-markdown@2.2.3: + resolution: {integrity: sha512-dImdB6VZRMRac1SwAW6o1c0ESk/7pFFAMCMuKM+9v7LpTSthMM5nzXpqKw4Mjo66aXVKhNkyrP4bMB9MurPyWg==} + + mdast-util-to-string@4.0.0: + resolution: {integrity: sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==} + + mdn-data@2.0.28: + resolution: {integrity: sha512-aylIc7Z9y4yzHYAJNuESG3hfhC+0Ibp/MAMiaOZgNv4pmEdFyfZhhhny4MNiAfWdBQ1RQ2mfDWmM1x8SvGyp8g==} + + mdn-data@2.27.1: + resolution: {integrity: sha512-9Yubnt3e8A0OKwxYSXyhLymGW4sCufcLG6VdiDdUGVkPhpqLxlvP5vl1983gQjJl3tqbrM731mjaZaP68AgosQ==} + + micromark-core-commonmark@2.0.4: + resolution: {integrity: sha512-wxEeE8v8XVvOrxn1TZj74qYhAtTQsSqufHVS3uNVyT1MupXxhyaHk8/9xDNPh9BmL77QNDgWTkZ3RsYHB2ry7w==} + + micromark-extension-directive@4.0.0: + resolution: {integrity: sha512-/C2nqVmXXmiseSSuCdItCMho7ybwwop6RrrRPk0KbOHW21JKoCldC+8rFOaundDoRBUWBnJJcxeA/Kvi34WQXg==} + + micromark-extension-gfm-autolink-literal@2.1.0: + resolution: {integrity: sha512-oOg7knzhicgQ3t4QCjCWgTmfNhvQbDDnJeVu9v81r7NltNCVmhPy1fJRX27pISafdjL+SVc4d3l48Gb6pbRypw==} + + micromark-extension-gfm-footnote@2.1.0: + resolution: {integrity: sha512-/yPhxI1ntnDNsiHtzLKYnE3vf9JZ6cAisqVDauhp4CEHxlb4uoOTxOCJ+9s51bIB8U1N1FJ1RXOKTIlD5B/gqw==} + + micromark-extension-gfm-strikethrough@2.1.0: + resolution: {integrity: sha512-ADVjpOOkjz1hhkZLlBiYA9cR2Anf8F4HqZUO6e5eDcPQd0Txw5fxLzzxnEkSkfnD0wziSGiv7sYhk/ktvbf1uw==} + + micromark-extension-gfm-table@2.1.2: + resolution: {integrity: sha512-pRzm4kDTu0MjlmBkxmS9yYhw60nncfcEwu9NNdPFSQEFXS95ZKyIIyTSHu/o3ReBUrLKYEq+7YaXCRn/bPB4MA==} + + micromark-extension-gfm-tagfilter@2.0.0: + resolution: {integrity: sha512-xHlTOmuCSotIA8TW1mDIM6X2O1SiX5P9IuDtqGonFhEK0qgRI4yeC6vMxEV2dgyr2TiD+2PQ10o+cOhdVAcwfg==} + + micromark-extension-gfm-task-list-item@2.1.0: + resolution: {integrity: sha512-qIBZhqxqI6fjLDYFTBIa4eivDMnP+OZqsNwmQ3xNLE4Cxwc+zfQEfbs6tzAo2Hjq+bh6q5F+Z8/cksrLFYWQQw==} + + micromark-extension-gfm@3.0.0: + resolution: {integrity: sha512-vsKArQsicm7t0z2GugkCKtZehqUm31oeGBV/KVSorWSy8ZlNAv7ytjFhvaryUiCUJYqs+NoE6AFhpQvBTM6Q4w==} + + micromark-extension-mdx-expression@3.0.1: + resolution: {integrity: sha512-dD/ADLJ1AeMvSAKBwO22zG22N4ybhe7kFIZ3LsDI0GlsNr2A3KYxb0LdC1u5rj4Nw+CHKY0RVdnHX8vj8ejm4Q==} + + micromark-extension-mdx-jsx@3.0.2: + resolution: {integrity: sha512-e5+q1DjMh62LZAJOnDraSSbDMvGJ8x3cbjygy2qFEi7HCeUT4BDKCvMozPozcD6WmOt6sVvYDNBKhFSz3kjOVQ==} + + micromark-extension-mdx-md@2.0.0: + resolution: {integrity: sha512-EpAiszsB3blw4Rpba7xTOUptcFeBFi+6PY8VnJ2hhimH+vCQDirWgsMpz7w1XcZE7LVrSAUGb9VJpG9ghlYvYQ==} + + micromark-extension-mdxjs-esm@3.0.0: + resolution: {integrity: sha512-DJFl4ZqkErRpq/dAPyeWp15tGrcrrJho1hKK5uBS70BCtfrIFg81sqcTVu3Ta+KD1Tk5vAtBNElWxtAa+m8K9A==} + + micromark-extension-mdxjs@3.0.0: + resolution: {integrity: sha512-A873fJfhnJ2siZyUrJ31l34Uqwy4xIFmvPY1oj+Ean5PHcPBYzEsvqvWGaWcfEIr11O5Dlw3p2y0tZWpKHDejQ==} + + micromark-factory-destination@2.0.1: + resolution: {integrity: sha512-Xe6rDdJlkmbFRExpTOmRj9N3MaWmbAgdpSrBQvCFqhezUn4AHqJHbaEnfbVYYiexVSs//tqOdY/DxhjdCiJnIA==} + + micromark-factory-label@2.0.1: + resolution: {integrity: sha512-VFMekyQExqIW7xIChcXn4ok29YE3rnuyveW3wZQWWqF4Nv9Wk5rgJ99KzPvHjkmPXF93FXIbBp6YdW3t71/7Vg==} + + micromark-factory-mdx-expression@2.0.3: + resolution: {integrity: sha512-kQnEtA3vzucU2BkrIa8/VaSAsP+EJ3CKOvhMuJgOEGg9KDC6OAY6nSnNDVRiVNRqj7Y4SlSzcStaH/5jge8JdQ==} + + micromark-factory-space@2.1.0: + resolution: {integrity: sha512-fS8hnLIjnjvdQIj39Geug8wWsR0HrYZ43KShKxNfwT7t2LOHo/LbWZEzEaSOjwtjdCsjoE6syHhonEzW0zv0+Q==} + + micromark-factory-title@2.0.1: + resolution: {integrity: sha512-5bZ+3CjhAd9eChYTHsjy6TGxpOFSKgKKJPJxr293jTbfry2KDoWkhBb6TcPVB4NmzaPhMs1Frm9AZH7OD4Cjzw==} + + micromark-factory-whitespace@2.0.1: + resolution: {integrity: sha512-Ob0nuZ3PKt/n0hORHyvoD9uZhr+Za8sFoP+OnMcnWK5lngSzALgQYKMr9RJVOWLqQYuyn6ulqGWSXdwf6F80lQ==} + + micromark-util-character@2.1.1: + resolution: {integrity: sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==} + + micromark-util-chunked@2.0.1: + resolution: {integrity: sha512-QUNFEOPELfmvv+4xiNg2sRYeS/P84pTW0TCgP5zc9FpXetHY0ab7SxKyAQCNCc1eK0459uoLI1y5oO5Vc1dbhA==} + + micromark-util-classify-character@2.0.1: + resolution: {integrity: sha512-K0kHzM6afW/MbeWYWLjoHQv1sgg2Q9EccHEDzSkxiP/EaagNzCm7T/WMKZ3rjMbvIpvBiZgwR3dKMygtA4mG1Q==} + + micromark-util-combine-extensions@2.0.1: + resolution: {integrity: sha512-OnAnH8Ujmy59JcyZw8JSbK9cGpdVY44NKgSM7E9Eh7DiLS2E9RNQf0dONaGDzEG9yjEl5hcqeIsj4hfRkLH/Bg==} + + micromark-util-decode-numeric-character-reference@2.0.2: + resolution: {integrity: sha512-ccUbYk6CwVdkmCQMyr64dXz42EfHGkPQlBj5p7YVGzq8I7CtjXZJrubAYezf7Rp+bjPseiROqe7G6foFd+lEuw==} + + micromark-util-decode-string@2.0.1: + resolution: {integrity: sha512-nDV/77Fj6eH1ynwscYTOsbK7rR//Uj0bZXBwJZRfaLEJ1iGBR6kIfNmlNqaqJf649EP0F3NWNdeJi03elllNUQ==} + + micromark-util-edit-map@1.0.0: + resolution: {integrity: sha512-Pa2ljlsEL6sVwFaYeyrOLSYbQt73JvGbPOYFq+9AElXiSnfI5Q4465RRZ1sHv7lDjDOnGRDDaqPXqClqWK/q1Q==} + + micromark-util-encode@2.0.1: + resolution: {integrity: sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==} + + micromark-util-events-to-acorn@2.0.3: + resolution: {integrity: sha512-jmsiEIiZ1n7X1Rr5k8wVExBQCg5jy4UXVADItHmNk1zkwEVhBuIUKRu3fqv+hs4nxLISi2DQGlqIOGiFxgbfHg==} + + micromark-util-html-tag-name@2.0.1: + resolution: {integrity: sha512-2cNEiYDhCWKI+Gs9T0Tiysk136SnR13hhO8yW6BGNyhOC4qYFnwF1nKfD3HFAIXA5c45RrIG1ub11GiXeYd1xA==} + + micromark-util-normalize-identifier@2.0.1: + resolution: {integrity: sha512-sxPqmo70LyARJs0w2UclACPUUEqltCkJ6PhKdMIDuJ3gSf/Q+/GIe3WKl0Ijb/GyH9lOpUkRAO2wp0GVkLvS9Q==} + + micromark-util-resolve-all@2.0.1: + resolution: {integrity: sha512-VdQyxFWFT2/FGJgwQnJYbe1jjQoNTS4RjglmSjTUlpUMa95Htx9NHeYW4rGDJzbjvCsl9eLjMQwGeElsqmzcHg==} + + micromark-util-sanitize-uri@2.0.1: + resolution: {integrity: sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ==} + + micromark-util-subtokenize@2.1.0: + resolution: {integrity: sha512-XQLu552iSctvnEcgXw6+Sx75GflAPNED1qx7eBJ+wydBb2KCbRZe+NwvIEEMM83uml1+2WSXpBAcp9IUCgCYWA==} + + micromark-util-symbol@2.0.1: + resolution: {integrity: sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==} + + micromark-util-types@2.0.3: + resolution: {integrity: sha512-oxB2Ik03hI0gv+VNn9tnh1t1YEe9MDPptViAEgfdf3YQHsn0pzGTgCdlSCJXcwhqm8phaEuM7zeEu3QQzVBrPg==} + + micromark@4.0.3: + resolution: {integrity: sha512-oGYfQzHSG5dOMovQcJ3fyTmZlWAWpi0XA0sJwJs+i6OT88o1+Jtw/8z0CmdowSLxGhhFK89rQ/oXph/wN02PNw==} + + mri@1.2.0: + resolution: {integrity: sha512-tzzskb3bG8LvYGFF/mDTpq3jpI6Q9wc3LEmBaghu+DdCssd1FakN7Bc0hVNmEyGq1bq3RgfkCb3cmQLpNPOroA==} + engines: {node: '>=4'} + + mrmime@2.0.1: + resolution: {integrity: sha512-Y3wQdFg2Va6etvQ5I82yUhGdsKrcYox6p7FfL1LbK2J4V01F9TGlepTIhnK24t7koZibmg82KGglhA1XK5IsLQ==} + engines: {node: '>=10'} + + ms@2.1.3: + resolution: {integrity: sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==} + + nanoid@3.3.20: + resolution: {integrity: sha512-uKdg2G3GNCKQn9byYOpxbGqrT2fGO5KRt5J/8b3pok8rT6qxGWF6hxMyJiEYtAf+FVyYuD9hRaDqX5uPFYJ4ZQ==} + engines: {node: ^10 || ^12 || ^13.7 || ^14 || >=15.0.1} + hasBin: true + + neotraverse@1.0.2: + resolution: {integrity: sha512-DLMUFnyCrRAncRJhDC2yNbSTcpEukp+nczID/na3XdIHQFokPveK69xel642cQHgUGszctsOSeCePqPpY25W6Q==} + engines: {node: '>= 10'} + + nlcst-to-string@4.0.0: + resolution: {integrity: sha512-YKLBCcUYKAg0FNlOBT6aI91qFmSiFKiluk655WzPF+DDMA02qIyy8uiRqI8QXtcFpEvll12LpL5MXqEmAZ+dcA==} + + node-fetch-native@1.6.7: + resolution: {integrity: sha512-g9yhqoedzIUm0nTnTqAQvueMPVOuIY16bqgAJJC8XOOubYFNwz6IER9qs0Gq2Xd0+CecCKFjtdDTMA4u4xG06Q==} + + node-mock-http@1.0.5: + resolution: {integrity: sha512-KQyt/wLjG3TAc7DOUhpqWzgd4ERxR80JOlTK5VE5R1S12IaPVN5qkj4klBce9HPG1Njuup4Sb5bljaT34lIyjw==} + + normalize-path@3.0.0: + resolution: {integrity: sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==} + engines: {node: '>=0.10.0'} + + nth-check@2.1.1: + resolution: {integrity: sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==} + + obug@3.0.0: + resolution: {integrity: sha512-5vvB5+W7ePv+p3uqxi+RcW1XAzLW0/hxt3/4X4Lc4qHudzOhmBiBwOY6DRob4WnanAEGvNcLjF+KNOufrUoEQw==} + engines: {node: '>=12.20.0'} + + ofetch@1.5.1: + resolution: {integrity: sha512-2W4oUZlVaqAPAil6FUg/difl6YhqhUR7x2eZY4bQCko22UXg3hptq9KLQdqFClV+Wu85UX7hNtdGTngi/1BxcA==} + + oniguruma-parser@0.12.2: + resolution: {integrity: sha512-6HVa5oIrgMC6aA6WF6XyyqbhRPJrKR02L20+2+zpDtO5QAzGHAUGw5TKQvwi5vctNnRHkJYmjAhRVQF2EKdTQw==} + + oniguruma-to-es@4.3.6: + resolution: {integrity: sha512-csuQ9x3Yr0cEIs/Zgx/OEt9iBw9vqIunAPQkx19R/fiMq2oGVTgcMqO/V3Ybqefr1TBvosI6jU539ksaBULJyA==} + + p-limit@7.3.3: + resolution: {integrity: sha512-SKgVvDU5TNIxQ4r30U75BNLC6a+6GOEjngrk/ysM5+Zu3oJuk1SC5ApzIzY/7PjCEjoVPMWJ0zho/4QUiEB7TQ==} + engines: {node: '>=20'} + + p-queue@10.0.0: + resolution: {integrity: sha512-P2wrCri3bhGLPo3kX7qYVXbo/5GvaVATU0DpO24CbeT53Y4z35t8JUWku04ERpXHUYB5rPMi3TkWE3fmJgx5rA==} + engines: {node: '>=22'} + + package-manager-detector@1.9.0: + resolution: {integrity: sha512-zAMfbta9nPA8AKkA4WdmNAT8R8s6Dk0/xwPsqNnRidMFcLo1YkLuPDTgs2f64XdzS8vbLNnoJ+uUIkgbz7oRHA==} + + pagefind@1.6.0: + resolution: {integrity: sha512-yeOd9EA0TUE1PUfbQIluBxzPadBG5/0BV48FAxwMVLkhZcOvwCz6TX4/a/Ofz97pF9/FwwT7CVbTC97BfmI+LQ==} + hasBin: true + + parse-entities@4.0.2: + resolution: {integrity: sha512-GG2AQYWoLgL877gQIKeRPGO1xF9+eG1ujIb5soS5gPvLQ1y2o8FL90w2QWNdf9I361Mpp7726c+lj3U0qK1uGw==} + + parse-latin@7.0.0: + resolution: {integrity: sha512-mhHgobPPua5kZ98EF4HWiH167JWBfl4pvAIXXdbaVohtK7a6YBOy56kvhCqduqyo/f3yrHFWmqmiMg/BkBkYYQ==} + + parse5@8.1.1: + resolution: {integrity: sha512-EcR/6WDcU7b2N3vQSxKALCk9lXGtUMQxXio008OEMBE0kavu/7JLfBEeFPzi43nMqVDSbEn3QCK+BMCc9zO//w==} + + piccolore@0.1.3: + resolution: {integrity: sha512-o8bTeDWjE086iwKrROaDf31K0qC/BENdm15/uH9usSC/uZjJOKb2YGiVHfLY4GhwsERiPI1jmwI2XrA7ACOxVw==} + + picocolors@1.1.1: + resolution: {integrity: sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==} + + picomatch@2.3.2: + resolution: {integrity: sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==} + engines: {node: '>=8.6'} + + picomatch@4.0.7: + resolution: {integrity: sha512-qcJu88Q2IWqJsDD529JKMdwGm/dvInW4HvQnRwiH9JtihJvzGOscDtHE3x1pBKeUOTysQ8kVmLnJ2kJu7yhcGA==} + engines: {node: '>=12'} + + postcss-nested@7.0.2: + resolution: {integrity: sha512-5osppouFc0VR9/VYzYxO03VaDa3e8F23Kfd6/9qcZTUI8P58GIYlArOET2Wq0ywSl2o2PjELhYOFI4W7l5QHKw==} + engines: {node: '>=18.0'} + peerDependencies: + postcss: ^8.2.14 + + postcss-selector-parser@7.2.1: + resolution: {integrity: sha512-GwxlMgTTXwIom+ebC7an3k6RaJDwklRQQnfiXsLPGicu8FYV/k/+1/9YY2OU2+r938H2t4X0TDxoif+HP2rjzQ==} + engines: {node: '>=4'} + + postcss@8.5.33: + resolution: {integrity: sha512-RVHEU9/Pp1Fnjr/MpAJsZoADukCKhfIi15OunEYiGktIkYLkPVvC1sioWolGDS7XByMTx9m/IGbro0Js13zhnQ==} + engines: {node: ^10 || ^12 || >=14} + + prismjs@1.30.0: + resolution: {integrity: sha512-DEvV2ZF2r2/63V+tK8hQvrR2ZGn10srHbXviTlcv7Kpzw8jWiNTqbVgjO3IY8RxrrOUF8VPMQQFysYYYv0YZxw==} + engines: {node: '>=6'} + + process-ancestry@0.1.0: + resolution: {integrity: sha512-tGqJW/UnclpYASFcM6Xh8D8l/BMtaQ9+CSG0vlJSJTcdMM4lDRv4c6H0Pdcsfted+bVczdYSfk2fdukg2gQkZg==} + engines: {node: '>=18.0.0'} + + property-information@7.2.0: + resolution: {integrity: sha512-IAtzIB6sUiWaJYrX9smp3V46pBGbBeLFRGdh25kg1334VcBlD8HzhPeNIWQH9zhGmo2itIe25EHt9dQP7G5hmg==} + + radix3@1.1.2: + resolution: {integrity: sha512-b484I/7b8rDEdSDKckSSBA8knMpcdsXudlE/LNL639wFoHKwLbEkQFZHWEYwDC0wa0FKUcCY+GAF73Z7wxNVFA==} + + readdirp@5.1.1: + resolution: {integrity: sha512-Kko+Y5XQ6fM+Ce3dq3m9YGxnacYZYl9cA1wZjaF3Vbry2L3i1qVg8+CAgNPsXRArPMUMCaOR7oa9Nqntc43JKA==} + engines: {node: '>= 20.19.0'} + + recma-build-jsx@1.0.0: + resolution: {integrity: sha512-8GtdyqaBcDfva+GUKDr3nev3VpKAhup1+RvkMvUxURHpW7QyIvk9F5wz7Vzo06CEMSilw6uArgRqhpiUcWp8ew==} + + recma-jsx@1.0.1: + resolution: {integrity: sha512-huSIy7VU2Z5OLv6oFLosQGGDqPqdO1iq6bWNAdhzMxSJP7RAso4fCZ1cKu8j9YHCZf3TPrq4dw3okhrylgcd7w==} + peerDependencies: + acorn: ^6.0.0 || ^7.0.0 || ^8.0.0 + + recma-parse@1.0.0: + resolution: {integrity: sha512-OYLsIGBB5Y5wjnSnQW6t3Xg7q3fQ7FWbw/vcXtORTnyaSFscOtABg+7Pnz6YZ6c27fG1/aN8CjfwoUEUIdwqWQ==} + + recma-stringify@1.0.0: + resolution: {integrity: sha512-cjwII1MdIIVloKvC9ErQ+OgAtwHBmcZ0Bg4ciz78FtbT8In39aAYbaA7zvxQ61xVMSPE8WxhLwLbhif4Js2C+g==} + + regex-recursion@6.0.2: + resolution: {integrity: sha512-0YCaSCq2VRIebiaUviZNs0cBz1kg5kVS2UKUfNIx8YVs1cN3AV7NTctO5FOKBA+UT2BPJIWZauYHPqJODG50cg==} + + regex-utilities@2.3.0: + resolution: {integrity: sha512-8VhliFJAWRaUiVvREIiW2NXXTmHs4vMNnSzuJVhscgmGav3g9VDxLrQndI3dZZVVdp0ZO/5v0xmX516/7M9cng==} + + regex@6.1.0: + resolution: {integrity: sha512-6VwtthbV4o/7+OaAF9I5L5V3llLEsoPyq9P1JVXkedTP33c7MfCG0/5NOPcSJn0TzXcG9YUrR0gQSWioew3LDg==} + + rehype-expressive-code@0.44.3: + resolution: {integrity: sha512-vaVuQPobFXvmtcHXQ5uqXZlzuuPnLyIuZcX/03sX1U/Qfj9fZrPYI9w66OSr/PUx6alzRYmreEwgYBbsVx8HsA==} + + rehype-raw@7.0.0: + resolution: {integrity: sha512-/aE8hCfKlQeA8LmyeyQvQF3eBiLRGNlfBJEvWH7ivp9sBqs7TNqBL5X3v157rM4IFETqDnIOO+z5M/biZbo9Ww==} + + rehype-recma@1.0.0: + resolution: {integrity: sha512-lqA4rGUf1JmacCNWWZx0Wv1dHqMwxzsDWYMTowuplHF3xH0N/MmrZ/G3BDZnzAkRmxDadujCjaKM2hqYdCBOGw==} + + rehype-stringify@10.0.1: + resolution: {integrity: sha512-k9ecfXHmIPuFVI61B9DeLPN0qFHfawM6RsuX48hoqlaKSF61RskNjSm1lI8PhBEM0MRdLxVVm4WmTqJQccH9mA==} + + remark-directive@4.0.0: + resolution: {integrity: sha512-7sxn4RfF1o3izevPV1DheyGDD6X4c9hrGpfdUpm7uC++dqrnJxIZVkk7CoKqcLm0VUMAuOol7Mno3m6g8cfMuA==} + + remark-gfm@4.0.1: + resolution: {integrity: sha512-1quofZ2RQ9EWdeN34S79+KExV1764+wCUGop5CPL1WGdD0ocPpu91lzPGbwWMECpEpd42kJGQwzRfyov9j4yNg==} + + remark-mdx@3.1.1: + resolution: {integrity: sha512-Pjj2IYlUY3+D8x00UJsIOg5BEvfMyeI+2uLPn9VO9Wg4MEtN/VTIq2NEJQfde9PnX15KgtHyl9S0BcTnWrIuWg==} + + remark-parse@11.0.0: + resolution: {integrity: sha512-FCxlKLNGknS5ba/1lmpYijMUzX2esxW5xQqjWxw2eHFfS2MSdaHVINFmhjo+qN1WhZhNimq0dZATN9pH0IDrpA==} + + remark-rehype@11.1.2: + resolution: {integrity: sha512-Dh7l57ianaEoIpzbp0PC9UKAdCSVklD8E5Rpw7ETfbTl3FqcOOgq5q2LVDhgGCkaBv7p24JXikPdvhhmHvKMsw==} + + remark-smartypants@3.0.3: + resolution: {integrity: sha512-gCaK+ndZ0hYezlqFegHFCVh2CQemsi0Npdh1qVM9bxlUFknjkbP6VmojWhddOCrbK0PbbacmYLWfTULRiT1eWA==} + engines: {node: '>=16.0.0'} + + remark-stringify@11.0.0: + resolution: {integrity: sha512-1OSmLd3awB/t8qdoEOMazZkNsfVTeY4fTsgzcQFdXNq8ToTN4ZGwrMnlda4K6smTFKD+GRV6O48i6Z4iKgPPpw==} + + resolve-pkg-maps@1.0.0: + resolution: {integrity: sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==} + + retext-latin@4.0.0: + resolution: {integrity: sha512-hv9woG7Fy0M9IlRQloq/N6atV82NxLGveq+3H2WOi79dtIYWN8OaxogDm77f8YnVXJL2VD3bbqowu5E3EMhBYA==} + + retext-smartypants@6.2.0: + resolution: {integrity: sha512-kk0jOU7+zGv//kfjXEBjdIryL1Acl4i9XNkHxtM7Tm5lFiCog576fjNC9hjoR7LTKQ0DsPWy09JummSsH1uqfQ==} + + retext-stringify@4.0.0: + resolution: {integrity: sha512-rtfN/0o8kL1e+78+uxPTqu1Klt0yPzKuQ2BfWwwfgIUSayyzxpM1PJzkKt4V8803uB9qSy32MvI7Xep9khTpiA==} + + retext@9.0.0: + resolution: {integrity: sha512-sbMDcpHCNjvlheSgMfEcVrZko3cDzdbe1x/e7G66dFp0Ff7Mldvi2uv6JkJQzdRcvLYE8CA8Oe8siQx8ZOgTcA==} + + rolldown@1.2.19: + resolution: {integrity: sha512-QIiV1J9d0pzN4jeeTH4sjPy0AZ6cAy2cG0ExeoE1+U8Rvj+hR3gYkokx0YbeUNGlZqiQJJ2utcETe0oKXwzsuA==} + engines: {node: ^20.19.0 || >=22.12.0} + hasBin: true + + satteri@0.10.5: + resolution: {integrity: sha512-Ao1LKpAEa9Wdg0otgbVKViZHEq9ebdXe4DMrp3s9vQAU0HNIuHnFEuMuOcm0ZIXyV0Yzxj91NvhLpvXZJO/5ZQ==} + + satteri@0.11.7: + resolution: {integrity: sha512-xDOSxkc1ew3z3IovIjmsqJaVHRXTGYJkPvx0LL/U6o90km8kSU+pmrZVvnWd5creJeE0UnvMEienlkPuYQdJaA==} + + sax@1.6.1: + resolution: {integrity: sha512-42tBVwLWnaQvW5zc4HbZrTuWccECCZfBi92FDuwtqxasH+JbPB3/FOKb1m222K42R4WxuxzzMsTswfzgtSu64Q==} + engines: {node: '>=11.0.0'} + + shiki@4.6.0: + resolution: {integrity: sha512-imjLsVHgPuWhvpU3P+zOekvMYqnel7QmKsFC4Sn0fCuAvaaalBsxwKEsrU8Ko5BdFnZA6Go/8a0RzahS634UgA==} + engines: {node: '>=20'} + + sisteransi@2.0.0: + resolution: {integrity: sha512-2WCqLdt12eN6ehLI50S2/ZxoowXU3DD1KVPRyVP0WEsFahrGZZmCdq1K59qjJljMRIDTwx1D9YaRK+hDneBUMg==} + engines: {node: '>=20'} + + sitemap@10.0.0: + resolution: {integrity: sha512-KSjl4H4KBEnGX5KXgzInPAycdOFhwLar0EmksDcYn6NqW2O+zLiMGeV2THE6tpuv3LCVdv+6xsSo2SWLGaBDKw==} + engines: {node: '>=22.22.1', npm: '>=10.8.2'} + hasBin: true + + smol-toml@1.9.1: + resolution: {integrity: sha512-j7WyPdf0CJoutMzMoPLF/bVXHtKZIT9Rb4eGeEbWw8X2t5oirjPgpL+OpaENZrILYaXqYwnVH+qgUwVbl+pUJQ==} + engines: {node: '>= 18'} + + source-map-js@1.2.2: + resolution: {integrity: sha512-KGj/8Y43x35aZVDtt+J4mK1hoLGHULMYfSkODJNQjNDC3oW1PqPoxMwo0pLUsWM/UEGzON/NxeHywEfNXNP3Vw==} + engines: {node: '>=0.10.0'} + + source-map@0.7.6: + resolution: {integrity: sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ==} + engines: {node: '>= 12'} + + source-map@0.8.0: + resolution: {integrity: sha512-d8EqvL+k/SOXCreS/SUzg2ciyHqBBLcN/yuRjFsbvVhHTE2pgei7oAhmPM7kWFbkX6OSMQfUq4KbkF3au9lhYQ==} + engines: {node: '>= 12'} + + space-separated-tokens@2.0.2: + resolution: {integrity: sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==} + + starlight-links-validator@0.27.0: + resolution: {integrity: sha512-UvPl8L9hfWR+yWbLOEtljLmpJCGcM6AVseVy5IO9dmqdOjW4R+Y8FaYyVA5axCC8RvxM5xU7M1WTerpwU8rYbw==} + peerDependencies: + '@astrojs/starlight': '>=0.42.0' + astro: '>=7.2.10' + + std-env@4.3.0: + resolution: {integrity: sha512-OtU/EgQ1kIm5KwqQpBC6ZEMXrZRui11w8zgfTWp8cdO9B8OaPsbA8bTHO2P+HNo1VlUTGMVBwPhydu6poeXiag==} + + stringify-entities@4.0.4: + resolution: {integrity: sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==} + + style-to-js@1.1.21: + resolution: {integrity: sha512-RjQetxJrrUJLQPHbLku6U/ocGtzyjbJMP9lCNK7Ag0CNh690nSH8woqWH9u16nMjYBAok+i7JO1NP2pOy8IsPQ==} + + style-to-object@1.0.14: + resolution: {integrity: sha512-LIN7rULI0jBscWQYaSswptyderlarFkjQ+t79nzty8tcIAceVomEVlLzH5VP4Cmsv6MtKhs7qaAiwlcp+Mgaxw==} + + style-to-object@2.0.2: + resolution: {integrity: sha512-QmbXPUylqU80HAgTOJeEOdbA40W9KtxmjMhQy+tq+b8F2aoh3aQLuy82hh2jm2qsC9hR9eI0+eQidTMydKcqRA==} + + supports-color@10.2.2: + resolution: {integrity: sha512-SS+jx45GF1QjgEXQx4NJZV9ImqmO2NPz5FNsIHrsDjh2YsHnawpan7SNQ1o8NuhrbHZy9AZhIoCUiCeaW/C80g==} + engines: {node: '>=18'} + + supports-hyperlinks@4.6.0: + resolution: {integrity: sha512-FL/q/YePS4tFFTNiBOR+zPk2ZrKheqNtmTJ/9OUZ4e1wKHJofDbGQSmSsxS0XNnabSkqexryCaXGvEKz1vf9UQ==} + engines: {node: '>=20'} + + svgo@4.1.0: + resolution: {integrity: sha512-bkxnTg1kSU0guhIBmibA6UUhrQmPVA1XsQLN+ylCd+UWzbnLkySOcXpyk1mrl05f+pcaCx2eHb+sp6BgMZWX+Q==} + engines: {node: '>=16'} + hasBin: true + + terminal-link@5.0.0: + resolution: {integrity: sha512-qFAy10MTMwjzjU8U16YS4YoZD+NQLHzLssFMNqgravjbvIPNiqkGFR4yjhJfmY9R5OFU7+yHxc6y+uGHkKwLRA==} + engines: {node: '>=20'} + + tiny-inflate@1.0.3: + resolution: {integrity: sha512-pkY1fj1cKHb2seWDy0B16HeWyczlJA9/WW3u3c4z/NiWDsO3DOU5D7nhTLE9CF0yXv/QZFY7sEJmj24dK+Rrqw==} + + tinyclip@1.0.3: + resolution: {integrity: sha512-nTv2raKFMzGG6JJp0lpNDsRPdfFE6UHlu2rVEjXo8vkx1ZS3LW2CVXqIaLu8xZlu+6tbFs9V58Qc/Jmk/Ii7wA==} + engines: {node: ^16.14.0 || >= 17.3.0} + + tinyexec@1.3.1: + resolution: {integrity: sha512-GCvB3aoys96IuDFBMcTB46JOR6mdMtAToqwiW8JlWhsoh1mhHi/xn9ss/Dg7N555GiJyEt2qzoG/NHCwM6h1EA==} + engines: {node: '>=18'} + + tinyglobby@0.2.17: + resolution: {integrity: sha512-wXR/dYpcqKmfWpEdZjiKJOwCNFndD0DMnrW/cYjVGttEkBfVgcLFHoNrlj47mjOVic9yyNu65alsgF4NQyTa2g==} + engines: {node: '>=12.0.0'} + + tinyps@0.5.2: + resolution: {integrity: sha512-sYhvdbpuo2rGE7u/jPUMiZz4H2LCaOodUtRD9ot4DLNFQbr884g9zozoJnxLI+1r4hXqWkmdHUl8Yig2Rllxxw==} + + trim-lines@3.0.1: + resolution: {integrity: sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==} + + trough@2.2.0: + resolution: {integrity: sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw==} + + tslib@2.9.1: + resolution: {integrity: sha512-a4Ux9VKuIMHsOS7ENbEq6hK2ZGYIT27Rtl0E4eD9KqwxhKiQeMZE/9xb3IdYwWaSOyIBQLExhQgXDTYoiCxnWA==} + + ufo@1.6.4: + resolution: {integrity: sha512-JFNbkD1Svwe0KvGi8GOeLcP4kAWQ609twvCdcHxq1oSL8svv39ZuSvajcD8B+5D0eL4+s1Is2D/O6KN3qcTeRA==} + + ultrahtml@1.7.0: + resolution: {integrity: sha512-2xRd0VHoAQE4M+vF/DvFFB7pUV0ZxTW1TLi7lHQWnF/Sb5TPeEUV/l+hxcNnGO00ZXGnR0voCMmYRKQf+rvJ2g==} + + uncrypto@0.1.3: + resolution: {integrity: sha512-Ql87qFHB3s/De2ClA9e0gsnS6zXG27SkTiSJwjCc9MebbfapQfuPzumMIUMi38ezPZVNFcHI9sUIepeQfw8J8Q==} + + undici-types@8.9.0: + resolution: {integrity: sha512-KTDyRTYX8sWmKXAikPHHSyc63CRPETMctyjKFupcC6OBLXT3xsN0e9aF7m+mIXutFWpUXuedtowG7iLOzp0kQg==} + + undici@8.12.4: + resolution: {integrity: sha512-8Mx+uNKKER2bA4AdtedkqRbwUCIJFr2nJckXRe5yrDqzePqwLP7VNcctN8/XdmDSbF7mS+jJKIszlL+vbam1VA==} + engines: {node: '>=22.19.0'} + + unified@11.0.5: + resolution: {integrity: sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA==} + + unifont@1.0.3: + resolution: {integrity: sha512-XGnEwj5sWdCbiBX01mWLSBncS0yMRjnLygau3IfdOlfjMacNIQvTGW4VH7pWBq+gGWArfSef/CensMLjMmIr/A==} + + unist-util-is@6.0.1: + resolution: {integrity: sha512-LsiILbtBETkDz8I9p1dQ0uyRUWuaQzd/cuEeS1hoRSyW5E5XGmTzlwY1OrNzzakGowI9Dr/I8HVaw4hTtnxy8g==} + + unist-util-modify-children@4.0.0: + resolution: {integrity: sha512-+tdN5fGNddvsQdIzUF3Xx82CU9sMM+fA0dLgR9vOmT0oPT2jH+P1nd5lSqfCfXAw+93NhcXNY2qqvTUtE4cQkw==} + + unist-util-position-from-estree@2.0.0: + resolution: {integrity: sha512-KaFVRjoqLyF6YXCbVLNad/eS4+OfPQQn2yOd7zF/h5T/CSL2v8NpN6a5TPvtbXthAGw5nG+PuTtq+DdIZr+cRQ==} + + unist-util-position@5.0.0: + resolution: {integrity: sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA==} + + unist-util-remove-position@5.0.0: + resolution: {integrity: sha512-Hp5Kh3wLxv0PHj9m2yZhhLt58KzPtEYKQQ4yxfYFEO7EvHwzyDYnduhHnY1mDxoqr7VUwVuHXk9RXKIiYS1N8Q==} + + unist-util-stringify-position@4.0.0: + resolution: {integrity: sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==} + + unist-util-visit-children@3.0.0: + resolution: {integrity: sha512-RgmdTfSBOg04sdPcpTSD1jzoNBjt9a80/ZCzp5cI9n1qPzLZWF9YdvWGN2zmTumP1HWhXKdUWexjy/Wy/lJ7tA==} + + unist-util-visit-parents@6.1.0: + resolution: {integrity: sha512-vKXxz6O38sKDj1mtx/k2cWvkkFBuYGx6uGrlzBkVeWCRF/F8sdI0j3Wbkz/5rVNRRuVc8UrgRdbCxNhmYXgP3w==} + + unist-util-visit@5.2.0: + resolution: {integrity: sha512-fpsYs/VVoZxfGY9/j3FQpZmN8wdLJaV1Pt38AaJNZu9uKIHcFU3halCdBveEq1HGKO1OEfJY65w1zvoFV1b3qQ==} + + unstorage@1.17.6: + resolution: {integrity: sha512-gjKtcmn/KwZuJZO9o2sc0esAQnhmTw0LviDHwevTXbJMYs0dRTp8ZEEWXHU0vTpzbN3cA0yxlTeyXssMp3zDqw==} + peerDependencies: + '@azure/app-configuration': ^1.8.0 + '@azure/cosmos': ^4.2.0 + '@azure/data-tables': ^13.3.0 + '@azure/identity': ^4.6.0 + '@azure/keyvault-secrets': ^4.9.0 + '@azure/storage-blob': ^12.26.0 + '@capacitor/preferences': ^6 || ^7 || ^8 + '@deno/kv': '>=0.9.0' + '@netlify/blobs': ^6.5.0 || ^7.0.0 || ^8.1.0 || ^9.0.0 || ^10.0.0 || ^11.0.0 + '@planetscale/database': ^1.19.0 + '@upstash/redis': ^1.34.3 + '@vercel/blob': '>=0.27.1' + '@vercel/functions': ^2.2.12 || ^3.0.0 + '@vercel/kv': ^1 || ^2 || ^3 + aws4fetch: ^1.0.20 + db0: '>=0.2.1' + idb-keyval: ^6.2.1 + ioredis: ^5.4.2 + uploadthing: ^7.4.4 + peerDependenciesMeta: + '@azure/app-configuration': + optional: true + '@azure/cosmos': + optional: true + '@azure/data-tables': + optional: true + '@azure/identity': + optional: true + '@azure/keyvault-secrets': + optional: true + '@azure/storage-blob': + optional: true + '@capacitor/preferences': + optional: true + '@deno/kv': + optional: true + '@netlify/blobs': + optional: true + '@planetscale/database': + optional: true + '@upstash/redis': + optional: true + '@vercel/blob': + optional: true + '@vercel/functions': + optional: true + '@vercel/kv': + optional: true + aws4fetch: + optional: true + db0: + optional: true + idb-keyval: + optional: true + ioredis: + optional: true + uploadthing: + optional: true + + url-extras@0.1.0: + resolution: {integrity: sha512-8tzwTeXFPuX/5PHuCDQE5Dd9Ts4rwoq2t9aIT+HS4iAVpmj5l4Ao7Q+BuuFjvWRqrLswBhQDk8O96ZicgCqQqw==} + engines: {node: '>=20'} + + util-deprecate@1.0.2: + resolution: {integrity: sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==} + + verkit@0.5.0: + resolution: {integrity: sha512-u4J1hr6Y+C/hit34GwL3eIcUf3wngT8TlYUjK7tk0jxydKLAq3sYvifjdTDA6U3KCKRcQCQDGf/srjxfZF3l7g==} + engines: {node: '>=18.12.0'} + + vfile-location@5.0.4: + resolution: {integrity: sha512-vEvxatYZCIpNvzGk2UD+u4I/sZkSKoOsdRCbkOIsN73QpJbriJ1qvvBAL1PeI0y55Leoqf7pORbaSPpG/smmOg==} + + vfile-message@4.0.4: + resolution: {integrity: sha512-66ycRswIkNmHH9PHku7ADtv5RVwgIrOcuv3J8Svz6h4qgGRrKVa+9/neuKyJZUXyOpYwLTvS+whZ4R2urHHgQg==} + + vfile@6.0.3: + resolution: {integrity: sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==} + + vite@8.3.8: + resolution: {integrity: sha512-LzOn3h9rG/0vhLdXrV4yJ4QFA9eEoqCl+Yx+kGJd7aB9w6nfNgVHKSYwLPZUHrz4ZGa+t+kXjV9itvcHDLQouA==} + engines: {node: ^20.19.0 || >=22.12.0} + hasBin: true + peerDependencies: + '@types/node': ^20.19.0 || >=22.12.0 + '@vitejs/devtools': ^0.7.1 || ^0.8.0 + esbuild: ^0.27.0 || ^0.28.0 + jiti: '>=1.21.0' + less: ^4.0.0 + sass: ^1.70.0 + sass-embedded: ^1.70.0 + stylus: '>=0.54.8' + sugarss: ^5.0.0 + terser: ^5.16.0 + tsx: ^4.8.1 + yaml: ^2.4.2 + peerDependenciesMeta: + '@types/node': + optional: true + '@vitejs/devtools': + optional: true + esbuild: + optional: true + jiti: + optional: true + less: + optional: true + sass: + optional: true + sass-embedded: + optional: true + stylus: + optional: true + sugarss: + optional: true + terser: + optional: true + tsx: + optional: true + yaml: + optional: true + + vitefu@1.1.3: + resolution: {integrity: sha512-ub4okH7Z5KLjb6hDyjqrGXqWtWvoYdU3IGm/NorpgHncKoLTCfRIbvlhBm7r0YstIaQRYlp4yEbFqDcKSzXSSg==} + peerDependencies: + vite: ^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0 + peerDependenciesMeta: + vite: + optional: true + + web-namespaces@2.0.1: + resolution: {integrity: sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ==} + + xxhash-wasm@1.1.0: + resolution: {integrity: sha512-147y/6YNh+tlp6nd/2pWq38i9h6mz/EuQ6njIrmW8D1BS5nCqs0P6DG+m6zTGnNz5I+uhZ0SHxBs9BsPrwcKDA==} + + yaml@2.9.1: + resolution: {integrity: sha512-3NxN8+78OdzbT7C/WjGsyfPAtJaN3FNDsWxv7Y7mcDsT/oOmgW8BpyQQFFBnvZE3j9Y2Sdz1ULFLezL7Eb2yFw==} + engines: {node: '>= 14.6'} + hasBin: true + + yocto-queue@1.2.2: + resolution: {integrity: sha512-4LCcse/U2MHZ63HAJVE+v71o7yOdIe4cZ70Wpf8D/IyjDKYQLV5GD46B+hSTjJsvV5PztjvHoU580EftxjDZFQ==} + engines: {node: '>=12.20'} + + zod@4.6.7: + resolution: {integrity: sha512-g8W2D2kU6a8untc053fX1uVBKzM7yqAxW/3zwk83+6RyF2+SKOuV+c0wBDhUwzV1PaGapmZH+rmcUzPf+3CGwg==} + + zwitch@2.0.4: + resolution: {integrity: sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==} + +snapshots: + + '@astrojs/compiler-binding-android-arm64@0.5.3': + optional: true + + '@astrojs/compiler-binding-darwin-arm64@0.5.3': + optional: true + + '@astrojs/compiler-binding-darwin-x64@0.5.3': + optional: true + + '@astrojs/compiler-binding-linux-arm64-gnu@0.5.3': + optional: true + + '@astrojs/compiler-binding-linux-arm64-musl@0.5.3': + optional: true + + '@astrojs/compiler-binding-linux-x64-gnu@0.5.3': + optional: true + + '@astrojs/compiler-binding-linux-x64-musl@0.5.3': + optional: true + + '@astrojs/compiler-binding-wasm32-wasi@0.5.3': + dependencies: + '@emnapi/core': 1.11.3 + '@emnapi/runtime': 1.11.3 + '@napi-rs/wasm-runtime': 1.2.7(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3) + optional: true + + '@astrojs/compiler-binding-win32-arm64-msvc@0.5.3': + optional: true + + '@astrojs/compiler-binding-win32-x64-msvc@0.5.3': + optional: true + + '@astrojs/compiler-binding@0.5.3': + optionalDependencies: + '@astrojs/compiler-binding-android-arm64': 0.5.3 + '@astrojs/compiler-binding-darwin-arm64': 0.5.3 + '@astrojs/compiler-binding-darwin-x64': 0.5.3 + '@astrojs/compiler-binding-linux-arm64-gnu': 0.5.3 + '@astrojs/compiler-binding-linux-arm64-musl': 0.5.3 + '@astrojs/compiler-binding-linux-x64-gnu': 0.5.3 + '@astrojs/compiler-binding-linux-x64-musl': 0.5.3 + '@astrojs/compiler-binding-wasm32-wasi': 0.5.3 + '@astrojs/compiler-binding-win32-arm64-msvc': 0.5.3 + '@astrojs/compiler-binding-win32-x64-msvc': 0.5.3 + + '@astrojs/compiler-rs@0.5.3': + dependencies: + '@astrojs/compiler-binding': 0.5.3 + + '@astrojs/internal-helpers@0.13.2': + dependencies: + '@types/hast': 3.0.5 + '@types/mdast': 4.0.4 + picomatch: 4.0.7 + retext-smartypants: 6.2.0 + shiki: 4.6.0 + smol-toml: 1.9.1 + unified: 11.0.5 + yaml: 2.9.1 + + '@astrojs/markdown-remark@7.3.9(supports-color@10.2.2)': + dependencies: + '@astrojs/internal-helpers': 0.13.2 + '@astrojs/prism': 4.1.2 + '@mdx-js/mdx': 3.1.1(supports-color@10.2.2) + acorn: 8.19.0 + estree-util-visit: 2.0.0 + github-slugger: 2.0.0 + hast-util-from-html: 2.1.0 + hast-util-to-html: 9.0.6 + hast-util-to-text: 4.0.3 + mdast-util-definitions: 6.0.0 + rehype-raw: 7.0.0 + rehype-stringify: 10.0.1 + remark-gfm: 4.0.1(supports-color@10.2.2) + remark-parse: 11.0.0(supports-color@10.2.2) + remark-rehype: 11.1.2 + remark-smartypants: 3.0.3 + source-map: 0.8.0 + unified: 11.0.5 + unist-util-remove-position: 5.0.0 + unist-util-visit: 5.2.0 + unist-util-visit-parents: 6.1.0 + vfile: 6.0.3 + transitivePeerDependencies: + - supports-color + + '@astrojs/markdown-satteri@0.4.10': + dependencies: + '@astrojs/internal-helpers': 0.13.2 + '@astrojs/prism': 4.1.2 + github-slugger: 2.0.0 + satteri: 0.11.7 + + '@astrojs/mdx@8.1.6(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@astrojs/markdown-satteri@0.4.10)(astro@7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1))': + dependencies: + '@astrojs/internal-helpers': 0.13.2 + '@astrojs/markdown-satteri': 0.4.10 + astro: 7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1) + es-module-lexer: 3.0.4 + optionalDependencies: + '@astrojs/markdown-remark': 7.3.9(supports-color@10.2.2) + + '@astrojs/prism@4.1.2': + dependencies: + prismjs: 1.30.0 + + '@astrojs/runtime@0.1.1': + dependencies: + '@oslojs/encoding': 1.1.0 + clsx: 2.1.1 + + '@astrojs/sitemap@3.7.5': + dependencies: + sitemap: 10.0.0 + zod: 4.6.7 + + '@astrojs/starlight@0.43.1(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(astro@7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1))(supports-color@10.2.2)': + dependencies: + '@astrojs/markdown-satteri': 0.4.10 + '@astrojs/mdx': 8.1.6(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@astrojs/markdown-satteri@0.4.10)(astro@7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1)) + '@astrojs/sitemap': 3.7.5 + '@pagefind/default-ui': 1.6.0 + '@types/hast': 3.0.5 + '@types/mdast': 4.0.4 + astro: 7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1) + astro-expressive-code: 0.44.3(astro@7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1)) + bcp-47: 2.1.2 + hast-util-format: 1.1.0 + hast-util-select: 6.0.4 + hast-util-to-html: 9.0.6 + hast-util-to-string: 3.0.1 + hastscript: 9.0.3 + i18next: 27.1.2 + klona: 2.0.6 + magic-string: 1.4.5 + mdast-util-directive: 3.2.0(supports-color@10.2.2) + mdast-util-to-markdown: 2.2.3 + mdast-util-to-string: 4.0.0 + pagefind: 1.6.0 + remark-directive: 4.0.0(supports-color@10.2.2) + satteri: 0.10.5 + ultrahtml: 1.7.0 + unified: 11.0.5 + unist-util-visit: 5.2.0 + vfile: 6.0.3 + yaml: 2.9.1 + optionalDependencies: + '@astrojs/markdown-remark': 7.3.9(supports-color@10.2.2) + transitivePeerDependencies: + - supports-color + - typescript + + '@astrojs/telemetry@3.4.2': + dependencies: + ci-info: 4.5.0 + dset: 3.1.4 + is-docker: 4.0.0 + package-manager-detector: 1.9.0 + + '@astrojs/vite-plugin-astro@0.1.3(vite@8.3.8(@types/node@26.6.6)(yaml@2.9.1))': + dependencies: + '@astrojs/compiler-rs': 0.5.3 + '@astrojs/internal-helpers': 0.13.2 + '@astrojs/runtime': 0.1.1 + common-ancestor-path: 2.0.0 + devalue: 6.0.3 + magic-string: 1.4.5 + rolldown: 1.2.19 + smol-toml: 1.9.1 + vite: 8.3.8(@types/node@26.6.6)(yaml@2.9.1) + zod: 4.6.7 + + '@babel/helper-string-parser@7.29.14': {} + + '@babel/helper-validator-identifier@7.29.7': {} + + '@babel/parser@7.29.14': + dependencies: + '@babel/types': 7.29.14 + + '@babel/types@7.29.14': + dependencies: + '@babel/helper-string-parser': 7.29.14 + '@babel/helper-validator-identifier': 7.29.7 + + '@bruits/satteri-android-arm64@0.11.7': + optional: true + + '@bruits/satteri-darwin-arm64@0.10.5': + optional: true + + '@bruits/satteri-darwin-arm64@0.11.7': + optional: true + + '@bruits/satteri-darwin-x64@0.10.5': + optional: true + + '@bruits/satteri-darwin-x64@0.11.7': + optional: true + + '@bruits/satteri-freebsd-x64@0.11.7': + optional: true + + '@bruits/satteri-linux-arm64-gnu@0.10.5': + optional: true + + '@bruits/satteri-linux-arm64-gnu@0.11.7': + optional: true + + '@bruits/satteri-linux-arm64-musl@0.10.5': + optional: true + + '@bruits/satteri-linux-arm64-musl@0.11.7': + optional: true + + '@bruits/satteri-linux-x64-gnu@0.10.5': + optional: true + + '@bruits/satteri-linux-x64-gnu@0.11.7': + optional: true + + '@bruits/satteri-linux-x64-musl@0.10.5': + optional: true + + '@bruits/satteri-linux-x64-musl@0.11.7': + optional: true + + '@bruits/satteri-wasm32-wasi@0.10.5': + dependencies: + '@emnapi/core': 1.11.1 + '@emnapi/runtime': 1.11.1 + '@napi-rs/wasm-runtime': 1.2.7(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1) + optional: true + + '@bruits/satteri-wasm32-wasi@0.11.7': + dependencies: + '@emnapi/core': 1.11.1 + '@emnapi/runtime': 1.11.1 + '@napi-rs/wasm-runtime': 1.2.7(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1) + optional: true + + '@bruits/satteri-win32-arm64-msvc@0.10.5': + optional: true + + '@bruits/satteri-win32-arm64-msvc@0.11.7': + optional: true + + '@bruits/satteri-win32-x64-msvc@0.10.5': + optional: true + + '@bruits/satteri-win32-x64-msvc@0.11.7': + optional: true + + '@capsizecss/unpack@4.0.1': + dependencies: + fontkitten: 1.0.3 + + '@clack/core@1.6.0': + dependencies: + fast-string-width: 3.0.2 + fast-wrap-ansi: 0.2.2 + sisteransi: 2.0.0 + + '@clack/prompts@1.9.0': + dependencies: + '@clack/core': 1.6.0 + fast-string-width: 3.0.2 + fast-wrap-ansi: 0.2.2 + sisteransi: 2.0.0 + + '@ctrl/tinycolor@4.3.1': {} + + '@emnapi/core@1.11.1': + dependencies: + '@emnapi/wasi-threads': 1.2.2 + tslib: 2.9.1 + optional: true + + '@emnapi/core@1.11.3': + dependencies: + '@emnapi/wasi-threads': 1.2.3 + tslib: 2.9.1 + optional: true + + '@emnapi/core@2.0.0-beta.2': + dependencies: + '@emnapi/wasi-threads': 2.2.0 + tslib: 2.9.1 + optional: true + + '@emnapi/runtime@1.11.1': + dependencies: + tslib: 2.9.1 + optional: true + + '@emnapi/runtime@1.11.3': + dependencies: + tslib: 2.9.1 + optional: true + + '@emnapi/runtime@2.0.0-beta.2': + dependencies: + tslib: 2.9.1 + optional: true + + '@emnapi/wasi-threads@1.2.2': + dependencies: + tslib: 2.9.1 + optional: true + + '@emnapi/wasi-threads@1.2.3': + dependencies: + tslib: 2.9.1 + optional: true + + '@emnapi/wasi-threads@2.2.0': + dependencies: + tslib: 2.9.1 + optional: true + + '@expressive-code/core@0.44.3': + dependencies: + '@ctrl/tinycolor': 4.3.1 + hast-util-select: 6.0.4 + hast-util-to-html: 9.0.6 + hast-util-to-text: 4.0.3 + hastscript: 9.0.3 + postcss: 8.5.33 + postcss-nested: 7.0.2(postcss@8.5.33) + unist-util-visit: 5.2.0 + unist-util-visit-parents: 6.1.0 + + '@expressive-code/plugin-frames@0.44.3': + dependencies: + '@expressive-code/core': 0.44.3 + + '@expressive-code/plugin-shiki@0.44.3': + dependencies: + '@expressive-code/core': 0.44.3 + shiki: 4.6.0 + + '@expressive-code/plugin-text-markers@0.44.3': + dependencies: + '@expressive-code/core': 0.44.3 + + '@jridgewell/sourcemap-codec@1.6.0': {} + + '@mdx-js/mdx@3.1.1(supports-color@10.2.2)': + dependencies: + '@types/estree': 1.0.10 + '@types/estree-jsx': 1.0.5 + '@types/hast': 3.0.5 + '@types/mdx': 2.0.14 + acorn: 8.19.0 + collapse-white-space: 2.1.0 + devlop: 1.1.0 + estree-util-is-identifier-name: 3.0.0 + estree-util-scope: 1.0.1 + estree-walker: 3.0.3 + hast-util-to-jsx-runtime: 2.3.7(supports-color@10.2.2) + markdown-extensions: 2.0.0 + recma-build-jsx: 1.0.0 + recma-jsx: 1.0.1(acorn@8.19.0) + recma-stringify: 1.0.0 + rehype-recma: 1.0.0(supports-color@10.2.2) + remark-mdx: 3.1.1(supports-color@10.2.2) + remark-parse: 11.0.0(supports-color@10.2.2) + remark-rehype: 11.1.2 + source-map: 0.7.6 + unified: 11.0.5 + unist-util-position-from-estree: 2.0.0 + unist-util-stringify-position: 4.0.0 + unist-util-visit: 5.2.0 + vfile: 6.0.3 + transitivePeerDependencies: + - supports-color + + '@napi-rs/wasm-runtime@1.2.6(@emnapi/core@2.0.0-beta.2)(@emnapi/runtime@2.0.0-beta.2)': + dependencies: + '@emnapi/core': 2.0.0-beta.2 + '@emnapi/runtime': 2.0.0-beta.2 + '@tybys/wasm-util': 0.10.4 + optional: true + + '@napi-rs/wasm-runtime@1.2.7(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)': + dependencies: + '@emnapi/core': 1.11.1 + '@emnapi/runtime': 1.11.1 + '@tybys/wasm-util': 0.10.4 + optional: true + + '@napi-rs/wasm-runtime@1.2.7(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3)': + dependencies: + '@emnapi/core': 1.11.3 + '@emnapi/runtime': 1.11.3 + '@tybys/wasm-util': 0.10.4 + optional: true + + '@oslojs/encoding@1.1.0': {} + + '@oxc-project/types@0.156.0': {} + + '@pagefind/darwin-arm64@1.6.0': + optional: true + + '@pagefind/darwin-x64@1.6.0': + optional: true + + '@pagefind/default-ui@1.6.0': {} + + '@pagefind/freebsd-x64@1.6.0': + optional: true + + '@pagefind/linux-arm64@1.6.0': + optional: true + + '@pagefind/linux-x64@1.6.0': + optional: true + + '@pagefind/windows-arm64@1.6.0': + optional: true + + '@pagefind/windows-x64@1.6.0': + optional: true + + '@rolldown/binding-android-arm-eabi@1.2.19': + optional: true + + '@rolldown/binding-android-arm64@1.2.19': + optional: true + + '@rolldown/binding-darwin-arm64@1.2.19': + optional: true + + '@rolldown/binding-darwin-x64@1.2.19': + optional: true + + '@rolldown/binding-freebsd-x64@1.2.19': + optional: true + + '@rolldown/binding-linux-arm-gnueabihf@1.2.19': + optional: true + + '@rolldown/binding-linux-arm64-gnu@1.2.19': + optional: true + + '@rolldown/binding-linux-arm64-musl@1.2.19': + optional: true + + '@rolldown/binding-linux-ppc64-gnu@1.2.19': + optional: true + + '@rolldown/binding-linux-s390x-gnu@1.2.19': + optional: true + + '@rolldown/binding-linux-x64-gnu@1.2.19': + optional: true + + '@rolldown/binding-linux-x64-musl@1.2.19': + optional: true + + '@rolldown/binding-openharmony-arm64@1.2.19': + optional: true + + '@rolldown/binding-wasm32-wasi@1.2.19': + dependencies: + '@emnapi/core': 2.0.0-beta.2 + '@emnapi/runtime': 2.0.0-beta.2 + '@napi-rs/wasm-runtime': 1.2.6(@emnapi/core@2.0.0-beta.2)(@emnapi/runtime@2.0.0-beta.2) + optional: true + + '@rolldown/binding-win32-arm64-msvc@1.2.19': + optional: true + + '@rolldown/binding-win32-x64-msvc@1.2.19': + optional: true + + '@rolldown/pluginutils@1.1.1': {} + + '@shikijs/core@4.6.0': + dependencies: + '@shikijs/primitive': 4.6.0 + '@shikijs/types': 4.6.0 + '@shikijs/vscode-textmate': 10.1.0 + '@types/hast': 3.0.5 + hast-util-to-html: 9.0.6 + + '@shikijs/engine-javascript@4.6.0': + dependencies: + '@shikijs/types': 4.6.0 + '@shikijs/vscode-textmate': 10.1.0 + oniguruma-to-es: 4.3.6 + + '@shikijs/engine-oniguruma@4.6.0': + dependencies: + '@shikijs/types': 4.6.0 + '@shikijs/vscode-textmate': 10.1.0 + + '@shikijs/langs@4.6.0': + dependencies: + '@shikijs/types': 4.6.0 + + '@shikijs/primitive@4.6.0': + dependencies: + '@shikijs/types': 4.6.0 + '@shikijs/vscode-textmate': 10.1.0 + '@types/hast': 3.0.5 + + '@shikijs/themes@4.6.0': + dependencies: + '@shikijs/types': 4.6.0 + + '@shikijs/types@4.6.0': + dependencies: + '@shikijs/vscode-textmate': 10.1.0 + '@types/hast': 3.0.5 + + '@shikijs/vscode-textmate@10.1.0': {} + + '@tybys/wasm-util@0.10.4': + dependencies: + tslib: 2.9.1 + optional: true + + '@types/debug@4.1.13': + dependencies: + '@types/ms': 2.1.0 + + '@types/estree-jsx@1.0.5': + dependencies: + '@types/estree': 1.0.10 + + '@types/estree@1.0.10': {} + + '@types/hast@3.0.5': + dependencies: + '@types/unist': 3.0.3 + + '@types/mdast@4.0.4': + dependencies: + '@types/unist': 3.0.3 + + '@types/mdx@2.0.14': {} + + '@types/ms@2.1.0': {} + + '@types/nlcst@2.0.3': + dependencies: + '@types/unist': 3.0.3 + + '@types/node@26.6.6': + dependencies: + undici-types: 8.9.0 + + '@types/sax@1.2.7': + dependencies: + '@types/node': 26.6.6 + + '@types/unist@2.0.11': {} + + '@types/unist@3.0.3': {} + + '@ungap/structured-clone@1.4.0': {} + + acorn-jsx@5.3.2(acorn@8.19.0): + dependencies: + acorn: 8.19.0 + + acorn@8.19.0: {} + + am-i-vibing@0.5.0: + dependencies: + process-ancestry: 0.1.0 + + ansi-escapes@7.3.0: + dependencies: + environment: 1.1.0 + + anymatch@3.1.3: + dependencies: + normalize-path: 3.0.0 + picomatch: 2.3.2 + + aria-query@5.3.2: {} + + array-iterate@2.0.1: {} + + astring@1.9.0: {} + + astro-expressive-code@0.44.3(astro@7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1)): + dependencies: + astro: 7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1) + rehype-expressive-code: 0.44.3 + url-extras: 0.1.0 + + astro@7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1): + dependencies: + '@astrojs/compiler-rs': 0.5.3 + '@astrojs/internal-helpers': 0.13.2 + '@astrojs/markdown-satteri': 0.4.10 + '@astrojs/runtime': 0.1.1 + '@astrojs/telemetry': 3.4.2 + '@astrojs/vite-plugin-astro': 0.1.3(vite@8.3.8(@types/node@26.6.6)(yaml@2.9.1)) + '@capsizecss/unpack': 4.0.1 + '@clack/prompts': 1.9.0 + '@oslojs/encoding': 1.1.0 + am-i-vibing: 0.5.0 + aria-query: 5.3.2 + axobject-query: 4.1.0 + ci-info: 4.5.0 + cookie: 2.0.2 + devalue: 6.0.3 + diff: 9.0.0 + dset: 3.1.4 + es-module-lexer: 3.0.4 + flattie: 1.1.1 + fontace: 0.4.1 + get-tsconfig: 5.0.0-beta.6 + github-slugger: 2.0.0 + html-escaper: 3.0.3 + http-cache-semantics: 4.3.0 + jsonc-parser: 3.3.1 + magic-string: 1.4.5 + magicast: 0.5.5 + mri: 1.2.0 + mrmime: 2.0.1 + neotraverse: 1.0.2 + obug: 3.0.0 + p-limit: 7.3.3 + p-queue: 10.0.0 + package-manager-detector: 1.9.0 + piccolore: 0.1.3 + picomatch: 4.0.7 + rolldown: 1.2.19 + shiki: 4.6.0 + smol-toml: 1.9.1 + svgo: 4.1.0 + tinyclip: 1.0.3 + tinyexec: 1.3.1 + tinyglobby: 0.2.17 + tinyps: 0.5.2 + ultrahtml: 1.7.0 + unifont: 1.0.3 + unstorage: 1.17.6 + verkit: 0.5.0 + vite: 8.3.8(@types/node@26.6.6)(yaml@2.9.1) + vitefu: 1.1.3(vite@8.3.8(@types/node@26.6.6)(yaml@2.9.1)) + xxhash-wasm: 1.1.0 + zod: 4.6.7 + optionalDependencies: + '@astrojs/markdown-remark': 7.3.9(supports-color@10.2.2) + transitivePeerDependencies: + - '@azure/app-configuration' + - '@azure/cosmos' + - '@azure/data-tables' + - '@azure/identity' + - '@azure/keyvault-secrets' + - '@azure/storage-blob' + - '@capacitor/preferences' + - '@deno/kv' + - '@netlify/blobs' + - '@planetscale/database' + - '@types/node' + - '@upstash/redis' + - '@vercel/blob' + - '@vercel/functions' + - '@vercel/kv' + - '@vitejs/devtools' + - aws4fetch + - db0 + - esbuild + - idb-keyval + - ioredis + - jiti + - less + - sass + - sass-embedded + - stylus + - sugarss + - terser + - tsx + - uploadthing + - yaml + + axobject-query@4.1.0: {} + + bail@2.0.2: {} + + bcp-47-match@2.0.3: {} + + bcp-47@2.1.2: + dependencies: + is-alphabetical: 2.0.1 + is-alphanumerical: 2.0.1 + is-decimal: 2.0.1 + + boolbase@1.0.0: {} + + ccount@2.0.1: {} + + character-entities-html4@2.1.0: {} + + character-entities-legacy@3.0.0: {} + + character-entities@2.0.2: {} + + character-reference-invalid@2.0.1: {} + + chokidar@5.0.0: + dependencies: + readdirp: 5.1.1 + + ci-info@4.5.0: {} + + clsx@2.1.1: {} + + collapse-white-space@2.1.0: {} + + comma-separated-tokens@2.0.3: {} + + commander@11.1.0: {} + + common-ancestor-path@2.0.0: {} + + cookie-es@1.2.3: {} + + cookie@2.0.2: {} + + crossws@0.3.5: + dependencies: + uncrypto: 0.1.3 + + css-select@6.0.0: + dependencies: + boolbase: 1.0.0 + css-what: 7.0.0 + domhandler: 5.0.3 + domutils: 3.2.2 + nth-check: 2.1.1 + + css-selector-parser@3.3.0: {} + + css-tree@2.2.1: + dependencies: + mdn-data: 2.0.28 + source-map-js: 1.2.2 + + css-tree@3.2.1: + dependencies: + mdn-data: 2.27.1 + source-map-js: 1.2.2 + + css-what@7.0.0: {} + + csso@5.0.5: + dependencies: + css-tree: 2.2.1 + + debug@4.4.3(supports-color@10.2.2): + dependencies: + ms: 2.1.3 + optionalDependencies: + supports-color: 10.2.2 + + decode-named-character-reference@1.3.0: + dependencies: + character-entities: 2.0.2 + + defu@6.1.7: {} + + dequal@2.0.3: {} + + destr@2.0.5: {} + + detect-libc@2.1.2: {} + + devalue@6.0.3: {} + + devlop@1.1.0: + dependencies: + dequal: 2.0.3 + + diff@9.0.0: {} + + direction@2.0.1: {} + + dom-serializer@2.0.0: + dependencies: + domelementtype: 2.3.0 + domhandler: 5.0.3 + entities: 4.5.0 + + domelementtype@2.3.0: {} + + domhandler@5.0.3: + dependencies: + domelementtype: 2.3.0 + + domutils@3.2.2: + dependencies: + dom-serializer: 2.0.0 + domelementtype: 2.3.0 + domhandler: 5.0.3 + + dset@3.1.4: {} + + entities@4.5.0: {} + + entities@9.0.0: {} + + environment@1.1.0: {} + + es-module-lexer@3.0.4: {} + + esast-util-from-estree@2.0.0: + dependencies: + '@types/estree-jsx': 1.0.5 + devlop: 1.1.0 + estree-util-visit: 2.0.0 + unist-util-position-from-estree: 2.0.0 + + esast-util-from-js@2.0.1: + dependencies: + '@types/estree-jsx': 1.0.5 + acorn: 8.19.0 + esast-util-from-estree: 2.0.0 + vfile-message: 4.0.4 + + escape-string-regexp@5.0.0: {} + + estree-util-attach-comments@3.0.0: + dependencies: + '@types/estree': 1.0.10 + + estree-util-build-jsx@3.0.1: + dependencies: + '@types/estree-jsx': 1.0.5 + devlop: 1.1.0 + estree-util-is-identifier-name: 3.0.0 + estree-walker: 3.0.3 + + estree-util-is-identifier-name@3.0.0: {} + + estree-util-scope@1.0.1: + dependencies: + '@types/estree': 1.0.10 + devlop: 1.1.0 + + estree-util-to-js@2.0.0: + dependencies: + '@types/estree-jsx': 1.0.5 + astring: 1.9.0 + source-map: 0.7.6 + + estree-util-visit@2.0.0: + dependencies: + '@types/estree-jsx': 1.0.5 + '@types/unist': 3.0.3 + + estree-walker@3.0.3: + dependencies: + '@types/estree': 1.0.10 + + expressive-code@0.44.3: + dependencies: + '@expressive-code/core': 0.44.3 + '@expressive-code/plugin-frames': 0.44.3 + '@expressive-code/plugin-shiki': 0.44.3 + '@expressive-code/plugin-text-markers': 0.44.3 + + extend@3.0.2: {} + + fast-string-truncated-width@3.0.3: {} + + fast-string-width@3.0.2: + dependencies: + fast-string-truncated-width: 3.0.3 + + fast-wrap-ansi@0.2.2: + dependencies: + fast-string-width: 3.0.2 + + fdir@6.5.0(picomatch@4.0.7): + optionalDependencies: + picomatch: 4.0.7 + + flattie@1.1.1: {} + + fnv1a-64@0.1.2: {} + + fontace@0.4.1: + dependencies: + fontkitten: 1.0.3 + + fontkitten@1.0.3: + dependencies: + tiny-inflate: 1.0.3 + + fsevents@2.3.3: + optional: true + + get-tsconfig@5.0.0-beta.6: + dependencies: + resolve-pkg-maps: 1.0.0 + + github-slugger@2.0.0: {} + + h3@1.15.11: + dependencies: + cookie-es: 1.2.3 + crossws: 0.3.5 + defu: 6.1.7 + destr: 2.0.5 + iron-webcrypto: 1.2.1 + node-mock-http: 1.0.5 + radix3: 1.1.2 + ufo: 1.6.4 + uncrypto: 0.1.3 + + has-flag@5.0.1: {} + + hast-util-embedded@3.0.0: + dependencies: + '@types/hast': 3.0.5 + hast-util-is-element: 3.0.0 + + hast-util-format@1.1.0: + dependencies: + '@types/hast': 3.0.5 + hast-util-embedded: 3.0.0 + hast-util-minify-whitespace: 1.0.1 + hast-util-phrasing: 3.0.1 + hast-util-whitespace: 3.0.0 + html-whitespace-sensitive-tag-names: 3.0.1 + unist-util-visit-parents: 6.1.0 + + hast-util-from-html@2.1.0: + dependencies: + '@types/hast': 3.0.5 + devlop: 1.1.0 + hast-util-from-parse5: 8.0.4 + parse5: 8.1.1 + vfile: 6.0.3 + vfile-message: 4.0.4 + + hast-util-from-parse5@8.0.4: + dependencies: + '@types/hast': 3.0.5 + '@types/unist': 3.0.3 + devlop: 1.1.0 + hastscript: 9.0.3 + property-information: 7.2.0 + vfile: 6.0.3 + vfile-location: 5.0.4 + web-namespaces: 2.0.1 + + hast-util-has-property@3.0.0: + dependencies: + '@types/hast': 3.0.5 + + hast-util-is-body-ok-link@3.0.1: + dependencies: + '@types/hast': 3.0.5 + + hast-util-is-element@3.0.0: + dependencies: + '@types/hast': 3.0.5 + + hast-util-minify-whitespace@1.0.1: + dependencies: + '@types/hast': 3.0.5 + hast-util-embedded: 3.0.0 + hast-util-is-element: 3.0.0 + hast-util-whitespace: 3.0.0 + unist-util-is: 6.0.1 + + hast-util-parse-selector@4.0.0: + dependencies: + '@types/hast': 3.0.5 + + hast-util-phrasing@3.0.1: + dependencies: + '@types/hast': 3.0.5 + hast-util-embedded: 3.0.0 + hast-util-has-property: 3.0.0 + hast-util-is-body-ok-link: 3.0.1 + hast-util-is-element: 3.0.0 + + hast-util-raw@9.2.0: + dependencies: + '@types/hast': 3.0.5 + '@types/unist': 3.0.3 + '@ungap/structured-clone': 1.4.0 + hast-util-from-parse5: 8.0.4 + hast-util-to-parse5: 8.0.1 + html-void-elements: 3.0.0 + mdast-util-to-hast: 13.2.2 + parse5: 8.1.1 + unist-util-position: 5.0.0 + unist-util-visit: 5.2.0 + vfile: 6.0.3 + web-namespaces: 2.0.1 + zwitch: 2.0.4 + + hast-util-select@6.0.4: + dependencies: + '@types/hast': 3.0.5 + '@types/unist': 3.0.3 + bcp-47-match: 2.0.3 + comma-separated-tokens: 2.0.3 + css-selector-parser: 3.3.0 + devlop: 1.1.0 + direction: 2.0.1 + hast-util-has-property: 3.0.0 + hast-util-to-string: 3.0.1 + hast-util-whitespace: 3.0.0 + nth-check: 2.1.1 + property-information: 7.2.0 + space-separated-tokens: 2.0.2 + unist-util-visit: 5.2.0 + zwitch: 2.0.4 + + hast-util-to-estree@3.1.3(supports-color@10.2.2): + dependencies: + '@types/estree': 1.0.10 + '@types/estree-jsx': 1.0.5 + '@types/hast': 3.0.5 + comma-separated-tokens: 2.0.3 + devlop: 1.1.0 + estree-util-attach-comments: 3.0.0 + estree-util-is-identifier-name: 3.0.0 + hast-util-whitespace: 3.0.0 + mdast-util-mdx-expression: 2.0.1(supports-color@10.2.2) + mdast-util-mdx-jsx: 3.2.1(supports-color@10.2.2) + mdast-util-mdxjs-esm: 2.0.1(supports-color@10.2.2) + property-information: 7.2.0 + space-separated-tokens: 2.0.2 + style-to-js: 1.1.21 + unist-util-position: 5.0.0 + zwitch: 2.0.4 + transitivePeerDependencies: + - supports-color + + hast-util-to-html@9.0.6: + dependencies: + '@types/hast': 3.0.5 + '@types/unist': 3.0.3 + ccount: 2.0.1 + comma-separated-tokens: 2.0.3 + hast-util-whitespace: 3.0.0 + html-void-elements: 3.0.0 + mdast-util-to-hast: 13.2.2 + property-information: 7.2.0 + space-separated-tokens: 2.0.2 + stringify-entities: 4.0.4 + zwitch: 2.0.4 + + hast-util-to-jsx-runtime@2.3.7(supports-color@10.2.2): + dependencies: + '@types/estree': 1.0.10 + '@types/hast': 3.0.5 + '@types/unist': 3.0.3 + comma-separated-tokens: 2.0.3 + devlop: 1.1.0 + estree-util-is-identifier-name: 3.0.0 + hast-util-whitespace: 3.0.0 + mdast-util-mdx-expression: 2.0.1(supports-color@10.2.2) + mdast-util-mdx-jsx: 3.2.1(supports-color@10.2.2) + mdast-util-mdxjs-esm: 2.0.1(supports-color@10.2.2) + property-information: 7.2.0 + space-separated-tokens: 2.0.2 + style-to-object: 2.0.2 + unist-util-position: 5.0.0 + vfile-message: 4.0.4 + transitivePeerDependencies: + - supports-color + + hast-util-to-parse5@8.0.1: + dependencies: + '@types/hast': 3.0.5 + comma-separated-tokens: 2.0.3 + devlop: 1.1.0 + property-information: 7.2.0 + space-separated-tokens: 2.0.2 + web-namespaces: 2.0.1 + zwitch: 2.0.4 + + hast-util-to-string@3.0.1: + dependencies: + '@types/hast': 3.0.5 + + hast-util-to-text@4.0.3: + dependencies: + '@types/hast': 3.0.5 + + hast-util-whitespace@3.0.0: + dependencies: + '@types/hast': 3.0.5 + + hastscript@9.0.3: + dependencies: + '@types/hast': 3.0.5 + comma-separated-tokens: 2.0.3 + hast-util-parse-selector: 4.0.0 + property-information: 7.2.0 + space-separated-tokens: 2.0.2 + + html-escaper@3.0.3: {} + + html-void-elements@3.0.0: {} + + html-whitespace-sensitive-tag-names@3.0.1: {} + + http-cache-semantics@4.3.0: {} + + i18next@27.1.2: {} + + inline-style-parser@0.2.7: {} + + inline-style-parser@0.2.9: {} + + iron-webcrypto@1.2.1: {} + + is-absolute-url@5.0.0: {} + + is-alphabetical@2.0.1: {} + + is-alphanumerical@2.0.1: + dependencies: + is-alphabetical: 2.0.1 + is-decimal: 2.0.1 + + is-decimal@2.0.1: {} + + is-docker@4.0.0: {} + + is-hexadecimal@2.0.1: {} + + is-plain-obj@4.1.0: {} + + jsonc-parser@3.3.1: {} + + klona@2.0.6: {} + + lightningcss-android-arm64@1.33.0: + optional: true + + lightningcss-darwin-arm64@1.33.0: + optional: true + + lightningcss-darwin-x64@1.33.0: + optional: true + + lightningcss-freebsd-x64@1.33.0: + optional: true + + lightningcss-linux-arm-gnueabihf@1.33.0: + optional: true + + lightningcss-linux-arm64-gnu@1.33.0: + optional: true + + lightningcss-linux-arm64-musl@1.33.0: + optional: true + + lightningcss-linux-x64-gnu@1.33.0: + optional: true + + lightningcss-linux-x64-musl@1.33.0: + optional: true + + lightningcss-win32-arm64-msvc@1.33.0: + optional: true + + lightningcss-win32-x64-msvc@1.33.0: + optional: true + + lightningcss@1.33.0: + dependencies: + detect-libc: 2.1.2 + optionalDependencies: + lightningcss-android-arm64: 1.33.0 + lightningcss-darwin-arm64: 1.33.0 + lightningcss-darwin-x64: 1.33.0 + lightningcss-freebsd-x64: 1.33.0 + lightningcss-linux-arm-gnueabihf: 1.33.0 + lightningcss-linux-arm64-gnu: 1.33.0 + lightningcss-linux-arm64-musl: 1.33.0 + lightningcss-linux-x64-gnu: 1.33.0 + lightningcss-linux-x64-musl: 1.33.0 + lightningcss-win32-arm64-msvc: 1.33.0 + lightningcss-win32-x64-msvc: 1.33.0 + + longest-streak@3.1.0: {} + + lru-cache@11.5.3: {} + + magic-string@1.4.5: + dependencies: + '@jridgewell/sourcemap-codec': 1.6.0 + + magicast@0.5.5: + dependencies: + '@babel/parser': 7.29.14 + '@babel/types': 7.29.14 + source-map-js: 1.2.2 + + markdown-extensions@2.0.0: {} + + markdown-table@3.1.0: {} + + mdast-util-definitions@6.0.0: + dependencies: + '@types/mdast': 4.0.4 + '@types/unist': 3.0.3 + unist-util-visit: 5.2.0 + + mdast-util-directive@3.2.0(supports-color@10.2.2): + dependencies: + '@types/mdast': 4.0.4 + '@types/unist': 3.0.3 + ccount: 2.0.1 + devlop: 1.1.0 + mdast-util-from-markdown: 2.1.0(supports-color@10.2.2) + mdast-util-to-markdown: 2.2.3 + micromark-util-character: 2.1.1 + parse-entities: 4.0.2 + stringify-entities: 4.0.4 + transitivePeerDependencies: + - supports-color + + mdast-util-find-and-replace@3.0.4: + dependencies: + '@types/mdast': 4.0.4 + escape-string-regexp: 5.0.0 + unist-util-is: 6.0.1 + unist-util-visit-parents: 6.1.0 + + mdast-util-from-markdown@2.1.0(supports-color@10.2.2): + dependencies: + '@types/mdast': 4.0.4 + '@types/unist': 3.0.3 + decode-named-character-reference: 1.3.0 + devlop: 1.1.0 + mdast-util-to-string: 4.0.0 + micromark: 4.0.3(supports-color@10.2.2) + micromark-util-decode-numeric-character-reference: 2.0.2 + micromark-util-decode-string: 2.0.1 + micromark-util-normalize-identifier: 2.0.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + unist-util-stringify-position: 4.0.0 + transitivePeerDependencies: + - supports-color + + mdast-util-gfm-autolink-literal@2.1.0: + dependencies: + '@types/mdast': 4.0.4 + ccount: 2.0.1 + devlop: 1.1.0 + mdast-util-find-and-replace: 3.0.4 + micromark-util-character: 2.1.1 + + mdast-util-gfm-footnote@2.1.0(supports-color@10.2.2): + dependencies: + '@types/mdast': 4.0.4 + devlop: 1.1.0 + mdast-util-from-markdown: 2.1.0(supports-color@10.2.2) + mdast-util-to-markdown: 2.2.3 + micromark-util-normalize-identifier: 2.0.1 + transitivePeerDependencies: + - supports-color + + mdast-util-gfm-strikethrough@2.0.1(supports-color@10.2.2): + dependencies: + '@types/mdast': 4.0.4 + mdast-util-from-markdown: 2.1.0(supports-color@10.2.2) + mdast-util-to-markdown: 2.2.3 + transitivePeerDependencies: + - supports-color + + mdast-util-gfm-table@2.0.1(supports-color@10.2.2): + dependencies: + '@types/mdast': 4.0.4 + devlop: 1.1.0 + markdown-table: 3.1.0 + mdast-util-from-markdown: 2.1.0(supports-color@10.2.2) + mdast-util-to-markdown: 2.2.3 + mdast-util-to-string: 4.0.0 + unist-util-visit: 5.2.0 + transitivePeerDependencies: + - supports-color + + mdast-util-gfm-task-list-item@2.0.1(supports-color@10.2.2): + dependencies: + '@types/mdast': 4.0.4 + devlop: 1.1.0 + mdast-util-from-markdown: 2.1.0(supports-color@10.2.2) + mdast-util-to-markdown: 2.2.3 + transitivePeerDependencies: + - supports-color + + mdast-util-gfm@3.1.0(supports-color@10.2.2): + dependencies: + mdast-util-from-markdown: 2.1.0(supports-color@10.2.2) + mdast-util-gfm-autolink-literal: 2.1.0 + mdast-util-gfm-footnote: 2.1.0(supports-color@10.2.2) + mdast-util-gfm-strikethrough: 2.0.1(supports-color@10.2.2) + mdast-util-gfm-table: 2.0.1(supports-color@10.2.2) + mdast-util-gfm-task-list-item: 2.0.1(supports-color@10.2.2) + mdast-util-to-markdown: 2.2.3 + transitivePeerDependencies: + - supports-color + + mdast-util-mdx-expression@2.0.1(supports-color@10.2.2): + dependencies: + '@types/estree-jsx': 1.0.5 + '@types/hast': 3.0.5 + '@types/mdast': 4.0.4 + devlop: 1.1.0 + mdast-util-from-markdown: 2.1.0(supports-color@10.2.2) + mdast-util-to-markdown: 2.2.3 + transitivePeerDependencies: + - supports-color + + mdast-util-mdx-jsx@3.2.1(supports-color@10.2.2): + dependencies: + '@types/estree-jsx': 1.0.5 + '@types/hast': 3.0.5 + '@types/mdast': 4.0.4 + '@types/unist': 3.0.3 + ccount: 2.0.1 + devlop: 1.1.0 + mdast-util-from-markdown: 2.1.0(supports-color@10.2.2) + mdast-util-to-markdown: 2.2.3 + parse-entities: 4.0.2 + stringify-entities: 4.0.4 + unist-util-stringify-position: 4.0.0 + vfile-message: 4.0.4 + transitivePeerDependencies: + - supports-color + + mdast-util-mdx@3.0.0(supports-color@10.2.2): + dependencies: + mdast-util-from-markdown: 2.1.0(supports-color@10.2.2) + mdast-util-mdx-expression: 2.0.1(supports-color@10.2.2) + mdast-util-mdx-jsx: 3.2.1(supports-color@10.2.2) + mdast-util-mdxjs-esm: 2.0.1(supports-color@10.2.2) + mdast-util-to-markdown: 2.2.3 + transitivePeerDependencies: + - supports-color + + mdast-util-mdxjs-esm@2.0.1(supports-color@10.2.2): + dependencies: + '@types/estree-jsx': 1.0.5 + '@types/hast': 3.0.5 + '@types/mdast': 4.0.4 + devlop: 1.1.0 + mdast-util-from-markdown: 2.1.0(supports-color@10.2.2) + mdast-util-to-markdown: 2.2.3 + transitivePeerDependencies: + - supports-color + + mdast-util-phrasing@4.1.0: + dependencies: + '@types/mdast': 4.0.4 + unist-util-is: 6.0.1 + + mdast-util-to-hast@13.2.2: + dependencies: + '@types/hast': 3.0.5 + '@types/mdast': 4.0.4 + '@ungap/structured-clone': 1.4.0 + devlop: 1.1.0 + micromark-util-sanitize-uri: 2.0.1 + trim-lines: 3.0.1 + unist-util-position: 5.0.0 + unist-util-visit: 5.2.0 + vfile: 6.0.3 + + mdast-util-to-markdown@2.2.3: + dependencies: + '@types/mdast': 4.0.4 + '@types/unist': 3.0.3 + longest-streak: 3.1.0 + mdast-util-phrasing: 4.1.0 + mdast-util-to-string: 4.0.0 + micromark-util-character: 2.1.1 + micromark-util-classify-character: 2.0.1 + micromark-util-decode-string: 2.0.1 + micromark-util-html-tag-name: 2.0.1 + unist-util-visit: 5.2.0 + zwitch: 2.0.4 + + mdast-util-to-string@4.0.0: + dependencies: + '@types/mdast': 4.0.4 + + mdn-data@2.0.28: {} + + mdn-data@2.27.1: {} + + micromark-core-commonmark@2.0.4: + dependencies: + decode-named-character-reference: 1.3.0 + devlop: 1.1.0 + micromark-factory-destination: 2.0.1 + micromark-factory-label: 2.0.1 + micromark-factory-space: 2.1.0 + micromark-factory-title: 2.0.1 + micromark-factory-whitespace: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-chunked: 2.0.1 + micromark-util-classify-character: 2.0.1 + micromark-util-edit-map: 1.0.0 + micromark-util-html-tag-name: 2.0.1 + micromark-util-normalize-identifier: 2.0.1 + micromark-util-resolve-all: 2.0.1 + micromark-util-subtokenize: 2.1.0 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-extension-directive@4.0.0: + dependencies: + devlop: 1.1.0 + micromark-factory-space: 2.1.0 + micromark-factory-whitespace: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + parse-entities: 4.0.2 + + micromark-extension-gfm-autolink-literal@2.1.0: + dependencies: + micromark-util-character: 2.1.1 + micromark-util-sanitize-uri: 2.0.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-extension-gfm-footnote@2.1.0: + dependencies: + devlop: 1.1.0 + micromark-core-commonmark: 2.0.4 + micromark-factory-space: 2.1.0 + micromark-util-character: 2.1.1 + micromark-util-normalize-identifier: 2.0.1 + micromark-util-sanitize-uri: 2.0.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-extension-gfm-strikethrough@2.1.0: + dependencies: + devlop: 1.1.0 + micromark-util-chunked: 2.0.1 + micromark-util-classify-character: 2.0.1 + micromark-util-resolve-all: 2.0.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-extension-gfm-table@2.1.2: + dependencies: + devlop: 1.1.0 + micromark-factory-space: 2.1.0 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-extension-gfm-tagfilter@2.0.0: + dependencies: + micromark-util-types: 2.0.3 + + micromark-extension-gfm-task-list-item@2.1.0: + dependencies: + devlop: 1.1.0 + micromark-factory-space: 2.1.0 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-extension-gfm@3.0.0: + dependencies: + micromark-extension-gfm-autolink-literal: 2.1.0 + micromark-extension-gfm-footnote: 2.1.0 + micromark-extension-gfm-strikethrough: 2.1.0 + micromark-extension-gfm-table: 2.1.2 + micromark-extension-gfm-tagfilter: 2.0.0 + micromark-extension-gfm-task-list-item: 2.1.0 + micromark-util-combine-extensions: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-extension-mdx-expression@3.0.1: + dependencies: + '@types/estree': 1.0.10 + devlop: 1.1.0 + micromark-factory-mdx-expression: 2.0.3 + micromark-factory-space: 2.1.0 + micromark-util-character: 2.1.1 + micromark-util-events-to-acorn: 2.0.3 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-extension-mdx-jsx@3.0.2: + dependencies: + '@types/estree': 1.0.10 + devlop: 1.1.0 + estree-util-is-identifier-name: 3.0.0 + micromark-factory-mdx-expression: 2.0.3 + micromark-factory-space: 2.1.0 + micromark-util-character: 2.1.1 + micromark-util-events-to-acorn: 2.0.3 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + vfile-message: 4.0.4 + + micromark-extension-mdx-md@2.0.0: + dependencies: + micromark-util-types: 2.0.3 + + micromark-extension-mdxjs-esm@3.0.0: + dependencies: + '@types/estree': 1.0.10 + devlop: 1.1.0 + micromark-core-commonmark: 2.0.4 + micromark-util-character: 2.1.1 + micromark-util-events-to-acorn: 2.0.3 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + unist-util-position-from-estree: 2.0.0 + vfile-message: 4.0.4 + + micromark-extension-mdxjs@3.0.0: + dependencies: + acorn: 8.19.0 + acorn-jsx: 5.3.2(acorn@8.19.0) + micromark-extension-mdx-expression: 3.0.1 + micromark-extension-mdx-jsx: 3.0.2 + micromark-extension-mdx-md: 2.0.0 + micromark-extension-mdxjs-esm: 3.0.0 + micromark-util-combine-extensions: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-factory-destination@2.0.1: + dependencies: + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-factory-label@2.0.1: + dependencies: + devlop: 1.1.0 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-factory-mdx-expression@2.0.3: + dependencies: + '@types/estree': 1.0.10 + devlop: 1.1.0 + micromark-factory-space: 2.1.0 + micromark-util-character: 2.1.1 + micromark-util-events-to-acorn: 2.0.3 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + unist-util-position-from-estree: 2.0.0 + vfile-message: 4.0.4 + + micromark-factory-space@2.1.0: + dependencies: + micromark-util-character: 2.1.1 + micromark-util-types: 2.0.3 + + micromark-factory-title@2.0.1: + dependencies: + micromark-factory-space: 2.1.0 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-factory-whitespace@2.0.1: + dependencies: + micromark-factory-space: 2.1.0 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-util-character@2.1.1: + dependencies: + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-util-chunked@2.0.1: + dependencies: + micromark-util-symbol: 2.0.1 + + micromark-util-classify-character@2.0.1: + dependencies: + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-util-combine-extensions@2.0.1: + dependencies: + micromark-util-chunked: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-util-decode-numeric-character-reference@2.0.2: + dependencies: + micromark-util-symbol: 2.0.1 + + micromark-util-decode-string@2.0.1: + dependencies: + decode-named-character-reference: 1.3.0 + micromark-util-character: 2.1.1 + micromark-util-decode-numeric-character-reference: 2.0.2 + micromark-util-symbol: 2.0.1 + + micromark-util-edit-map@1.0.0: + dependencies: + micromark-util-types: 2.0.3 + + micromark-util-encode@2.0.1: {} + + micromark-util-events-to-acorn@2.0.3: + dependencies: + '@types/estree': 1.0.10 + '@types/unist': 3.0.3 + devlop: 1.1.0 + estree-util-visit: 2.0.0 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + vfile-message: 4.0.4 + + micromark-util-html-tag-name@2.0.1: {} + + micromark-util-normalize-identifier@2.0.1: + dependencies: + micromark-util-symbol: 2.0.1 + + micromark-util-resolve-all@2.0.1: + dependencies: + micromark-util-types: 2.0.3 + + micromark-util-sanitize-uri@2.0.1: + dependencies: + micromark-util-character: 2.1.1 + micromark-util-encode: 2.0.1 + micromark-util-symbol: 2.0.1 + + micromark-util-subtokenize@2.1.0: + dependencies: + devlop: 1.1.0 + micromark-util-chunked: 2.0.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + + micromark-util-symbol@2.0.1: {} + + micromark-util-types@2.0.3: {} + + micromark@4.0.3(supports-color@10.2.2): + dependencies: + '@types/debug': 4.1.13 + debug: 4.4.3(supports-color@10.2.2) + decode-named-character-reference: 1.3.0 + devlop: 1.1.0 + micromark-core-commonmark: 2.0.4 + micromark-factory-space: 2.1.0 + micromark-util-character: 2.1.1 + micromark-util-chunked: 2.0.1 + micromark-util-combine-extensions: 2.0.1 + micromark-util-decode-numeric-character-reference: 2.0.2 + micromark-util-edit-map: 1.0.0 + micromark-util-encode: 2.0.1 + micromark-util-normalize-identifier: 2.0.1 + micromark-util-resolve-all: 2.0.1 + micromark-util-sanitize-uri: 2.0.1 + micromark-util-subtokenize: 2.1.0 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.3 + transitivePeerDependencies: + - supports-color + + mri@1.2.0: {} + + mrmime@2.0.1: {} + + ms@2.1.3: {} + + nanoid@3.3.20: {} + + neotraverse@1.0.2: {} + + nlcst-to-string@4.0.0: + dependencies: + '@types/nlcst': 2.0.3 + + node-fetch-native@1.6.7: {} + + node-mock-http@1.0.5: {} + + normalize-path@3.0.0: {} + + nth-check@2.1.1: + dependencies: + boolbase: 1.0.0 + + obug@3.0.0: {} + + ofetch@1.5.1: + dependencies: + destr: 2.0.5 + node-fetch-native: 1.6.7 + ufo: 1.6.4 + + oniguruma-parser@0.12.2: {} + + oniguruma-to-es@4.3.6: + dependencies: + oniguruma-parser: 0.12.2 + regex: 6.1.0 + regex-recursion: 6.0.2 + + p-limit@7.3.3: + dependencies: + yocto-queue: 1.2.2 + + p-queue@10.0.0: {} + + package-manager-detector@1.9.0: {} + + pagefind@1.6.0: + optionalDependencies: + '@pagefind/darwin-arm64': 1.6.0 + '@pagefind/darwin-x64': 1.6.0 + '@pagefind/freebsd-x64': 1.6.0 + '@pagefind/linux-arm64': 1.6.0 + '@pagefind/linux-x64': 1.6.0 + '@pagefind/windows-arm64': 1.6.0 + '@pagefind/windows-x64': 1.6.0 + + parse-entities@4.0.2: + dependencies: + '@types/unist': 2.0.11 + character-entities-legacy: 3.0.0 + character-reference-invalid: 2.0.1 + decode-named-character-reference: 1.3.0 + is-alphanumerical: 2.0.1 + is-decimal: 2.0.1 + is-hexadecimal: 2.0.1 + + parse-latin@7.0.0: + dependencies: + '@types/nlcst': 2.0.3 + '@types/unist': 3.0.3 + nlcst-to-string: 4.0.0 + unist-util-modify-children: 4.0.0 + unist-util-visit-children: 3.0.0 + vfile: 6.0.3 + + parse5@8.1.1: + dependencies: + entities: 9.0.0 + + piccolore@0.1.3: {} + + picocolors@1.1.1: {} + + picomatch@2.3.2: {} + + picomatch@4.0.7: {} + + postcss-nested@7.0.2(postcss@8.5.33): + dependencies: + postcss: 8.5.33 + postcss-selector-parser: 7.2.1 + + postcss-selector-parser@7.2.1: + dependencies: + util-deprecate: 1.0.2 + + postcss@8.5.33: + dependencies: + nanoid: 3.3.20 + picocolors: 1.1.1 + source-map-js: 1.2.2 + + prismjs@1.30.0: {} + + process-ancestry@0.1.0: {} + + property-information@7.2.0: {} + + radix3@1.1.2: {} + + readdirp@5.1.1: {} + + recma-build-jsx@1.0.0: + dependencies: + '@types/estree': 1.0.10 + estree-util-build-jsx: 3.0.1 + vfile: 6.0.3 + + recma-jsx@1.0.1(acorn@8.19.0): + dependencies: + acorn: 8.19.0 + acorn-jsx: 5.3.2(acorn@8.19.0) + estree-util-to-js: 2.0.0 + recma-parse: 1.0.0 + recma-stringify: 1.0.0 + unified: 11.0.5 + + recma-parse@1.0.0: + dependencies: + '@types/estree': 1.0.10 + esast-util-from-js: 2.0.1 + unified: 11.0.5 + vfile: 6.0.3 + + recma-stringify@1.0.0: + dependencies: + '@types/estree': 1.0.10 + estree-util-to-js: 2.0.0 + unified: 11.0.5 + vfile: 6.0.3 + + regex-recursion@6.0.2: + dependencies: + regex-utilities: 2.3.0 + + regex-utilities@2.3.0: {} + + regex@6.1.0: + dependencies: + regex-utilities: 2.3.0 + + rehype-expressive-code@0.44.3: + dependencies: + expressive-code: 0.44.3 + + rehype-raw@7.0.0: + dependencies: + '@types/hast': 3.0.5 + hast-util-raw: 9.2.0 + vfile: 6.0.3 + + rehype-recma@1.0.0(supports-color@10.2.2): + dependencies: + '@types/estree': 1.0.10 + '@types/hast': 3.0.5 + hast-util-to-estree: 3.1.3(supports-color@10.2.2) + transitivePeerDependencies: + - supports-color + + rehype-stringify@10.0.1: + dependencies: + '@types/hast': 3.0.5 + hast-util-to-html: 9.0.6 + unified: 11.0.5 + + remark-directive@4.0.0(supports-color@10.2.2): + dependencies: + '@types/mdast': 4.0.4 + mdast-util-directive: 3.2.0(supports-color@10.2.2) + micromark-extension-directive: 4.0.0 + unified: 11.0.5 + transitivePeerDependencies: + - supports-color + + remark-gfm@4.0.1(supports-color@10.2.2): + dependencies: + '@types/mdast': 4.0.4 + mdast-util-gfm: 3.1.0(supports-color@10.2.2) + micromark-extension-gfm: 3.0.0 + remark-parse: 11.0.0(supports-color@10.2.2) + remark-stringify: 11.0.0 + unified: 11.0.5 + transitivePeerDependencies: + - supports-color + + remark-mdx@3.1.1(supports-color@10.2.2): + dependencies: + mdast-util-mdx: 3.0.0(supports-color@10.2.2) + micromark-extension-mdxjs: 3.0.0 + transitivePeerDependencies: + - supports-color + + remark-parse@11.0.0(supports-color@10.2.2): + dependencies: + '@types/mdast': 4.0.4 + mdast-util-from-markdown: 2.1.0(supports-color@10.2.2) + micromark-util-types: 2.0.3 + unified: 11.0.5 + transitivePeerDependencies: + - supports-color + + remark-rehype@11.1.2: + dependencies: + '@types/hast': 3.0.5 + '@types/mdast': 4.0.4 + mdast-util-to-hast: 13.2.2 + unified: 11.0.5 + vfile: 6.0.3 + + remark-smartypants@3.0.3: + dependencies: + retext: 9.0.0 + retext-smartypants: 6.2.0 + unified: 11.0.5 + unist-util-visit: 5.2.0 + + remark-stringify@11.0.0: + dependencies: + '@types/mdast': 4.0.4 + mdast-util-to-markdown: 2.2.3 + unified: 11.0.5 + + resolve-pkg-maps@1.0.0: {} + + retext-latin@4.0.0: + dependencies: + '@types/nlcst': 2.0.3 + parse-latin: 7.0.0 + unified: 11.0.5 + + retext-smartypants@6.2.0: + dependencies: + '@types/nlcst': 2.0.3 + nlcst-to-string: 4.0.0 + unist-util-visit: 5.2.0 + + retext-stringify@4.0.0: + dependencies: + '@types/nlcst': 2.0.3 + nlcst-to-string: 4.0.0 + unified: 11.0.5 + + retext@9.0.0: + dependencies: + '@types/nlcst': 2.0.3 + retext-latin: 4.0.0 + retext-stringify: 4.0.0 + unified: 11.0.5 + + rolldown@1.2.19: + dependencies: + '@oxc-project/types': 0.156.0 + '@rolldown/pluginutils': 1.1.1 + optionalDependencies: + '@rolldown/binding-android-arm-eabi': 1.2.19 + '@rolldown/binding-android-arm64': 1.2.19 + '@rolldown/binding-darwin-arm64': 1.2.19 + '@rolldown/binding-darwin-x64': 1.2.19 + '@rolldown/binding-freebsd-x64': 1.2.19 + '@rolldown/binding-linux-arm-gnueabihf': 1.2.19 + '@rolldown/binding-linux-arm64-gnu': 1.2.19 + '@rolldown/binding-linux-arm64-musl': 1.2.19 + '@rolldown/binding-linux-ppc64-gnu': 1.2.19 + '@rolldown/binding-linux-s390x-gnu': 1.2.19 + '@rolldown/binding-linux-x64-gnu': 1.2.19 + '@rolldown/binding-linux-x64-musl': 1.2.19 + '@rolldown/binding-openharmony-arm64': 1.2.19 + '@rolldown/binding-wasm32-wasi': 1.2.19 + '@rolldown/binding-win32-arm64-msvc': 1.2.19 + '@rolldown/binding-win32-x64-msvc': 1.2.19 + + satteri@0.10.5: + dependencies: + '@types/estree-jsx': 1.0.5 + '@types/hast': 3.0.5 + '@types/mdast': 4.0.4 + '@types/unist': 3.0.3 + optionalDependencies: + '@bruits/satteri-darwin-arm64': 0.10.5 + '@bruits/satteri-darwin-x64': 0.10.5 + '@bruits/satteri-linux-arm64-gnu': 0.10.5 + '@bruits/satteri-linux-arm64-musl': 0.10.5 + '@bruits/satteri-linux-x64-gnu': 0.10.5 + '@bruits/satteri-linux-x64-musl': 0.10.5 + '@bruits/satteri-wasm32-wasi': 0.10.5 + '@bruits/satteri-win32-arm64-msvc': 0.10.5 + '@bruits/satteri-win32-x64-msvc': 0.10.5 + + satteri@0.11.7: + dependencies: + '@types/estree-jsx': 1.0.5 + '@types/hast': 3.0.5 + '@types/mdast': 4.0.4 + '@types/unist': 3.0.3 + optionalDependencies: + '@bruits/satteri-android-arm64': 0.11.7 + '@bruits/satteri-darwin-arm64': 0.11.7 + '@bruits/satteri-darwin-x64': 0.11.7 + '@bruits/satteri-freebsd-x64': 0.11.7 + '@bruits/satteri-linux-arm64-gnu': 0.11.7 + '@bruits/satteri-linux-arm64-musl': 0.11.7 + '@bruits/satteri-linux-x64-gnu': 0.11.7 + '@bruits/satteri-linux-x64-musl': 0.11.7 + '@bruits/satteri-wasm32-wasi': 0.11.7 + '@bruits/satteri-win32-arm64-msvc': 0.11.7 + '@bruits/satteri-win32-x64-msvc': 0.11.7 + + sax@1.6.1: {} + + shiki@4.6.0: + dependencies: + '@shikijs/core': 4.6.0 + '@shikijs/engine-javascript': 4.6.0 + '@shikijs/engine-oniguruma': 4.6.0 + '@shikijs/langs': 4.6.0 + '@shikijs/themes': 4.6.0 + '@shikijs/types': 4.6.0 + '@shikijs/vscode-textmate': 10.1.0 + '@types/hast': 3.0.5 + + sisteransi@2.0.0: {} + + sitemap@10.0.0: + dependencies: + '@types/node': 26.6.6 + '@types/sax': 1.2.7 + sax: 1.6.1 + + smol-toml@1.9.1: {} + + source-map-js@1.2.2: {} + + source-map@0.7.6: {} + + source-map@0.8.0: {} + + space-separated-tokens@2.0.2: {} + + starlight-links-validator@0.27.0(@astrojs/starlight@0.43.1(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(astro@7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1))(supports-color@10.2.2))(astro@7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1))(supports-color@10.2.2): + dependencies: + '@astrojs/markdown-satteri': 0.4.10 + '@astrojs/starlight': 0.43.1(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(astro@7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1))(supports-color@10.2.2) + astro: 7.4.12(@astrojs/markdown-remark@7.3.9(supports-color@10.2.2))(@types/node@26.6.6)(yaml@2.9.1) + github-slugger: 2.0.0 + hast-util-from-html: 2.1.0 + is-absolute-url: 5.0.0 + mdast-util-mdx-jsx: 3.2.1(supports-color@10.2.2) + mdast-util-to-hast: 13.2.2 + picomatch: 4.0.7 + satteri: 0.10.5 + terminal-link: 5.0.0 + unist-util-visit: 5.2.0 + yaml: 2.9.1 + transitivePeerDependencies: + - supports-color + + std-env@4.3.0: {} + + stringify-entities@4.0.4: + dependencies: + character-entities-html4: 2.1.0 + character-entities-legacy: 3.0.0 + + style-to-js@1.1.21: + dependencies: + style-to-object: 1.0.14 + + style-to-object@1.0.14: + dependencies: + inline-style-parser: 0.2.7 + + style-to-object@2.0.2: + dependencies: + inline-style-parser: 0.2.9 + + supports-color@10.2.2: {} + + supports-hyperlinks@4.6.0: + dependencies: + has-flag: 5.0.1 + supports-color: 10.2.2 + + svgo@4.1.0: + dependencies: + commander: 11.1.0 + css-select: 6.0.0 + css-tree: 3.2.1 + css-what: 7.0.0 + csso: 5.0.5 + picocolors: 1.1.1 + sax: 1.6.1 + + terminal-link@5.0.0: + dependencies: + ansi-escapes: 7.3.0 + supports-hyperlinks: 4.6.0 + + tiny-inflate@1.0.3: {} + + tinyclip@1.0.3: {} + + tinyexec@1.3.1: {} + + tinyglobby@0.2.17: + dependencies: + fdir: 6.5.0(picomatch@4.0.7) + picomatch: 4.0.7 + + tinyps@0.5.2: {} + + trim-lines@3.0.1: {} + + trough@2.2.0: {} + + tslib@2.9.1: + optional: true + + ufo@1.6.4: {} + + ultrahtml@1.7.0: {} + + uncrypto@0.1.3: {} + + undici-types@8.9.0: {} + + undici@8.12.4: {} + + unified@11.0.5: + dependencies: + '@types/unist': 3.0.3 + bail: 2.0.2 + devlop: 1.1.0 + extend: 3.0.2 + is-plain-obj: 4.1.0 + trough: 2.2.0 + vfile: 6.0.3 + + unifont@1.0.3: + dependencies: + css-tree: 3.2.1 + fnv1a-64: 0.1.2 + std-env: 4.3.0 + undici: 8.12.4 + + unist-util-is@6.0.1: + dependencies: + '@types/unist': 3.0.3 + + unist-util-modify-children@4.0.0: + dependencies: + '@types/unist': 3.0.3 + array-iterate: 2.0.1 + + unist-util-position-from-estree@2.0.0: + dependencies: + '@types/unist': 3.0.3 + + unist-util-position@5.0.0: + dependencies: + '@types/unist': 3.0.3 + + unist-util-remove-position@5.0.0: + dependencies: + '@types/unist': 3.0.3 + unist-util-visit: 5.2.0 + + unist-util-stringify-position@4.0.0: + dependencies: + '@types/unist': 3.0.3 + + unist-util-visit-children@3.0.0: + dependencies: + '@types/unist': 3.0.3 + + unist-util-visit-parents@6.1.0: + dependencies: + '@types/unist': 3.0.3 + unist-util-is: 6.0.1 + + unist-util-visit@5.2.0: + dependencies: + '@types/unist': 3.0.3 + unist-util-is: 6.0.1 + unist-util-visit-parents: 6.1.0 + + unstorage@1.17.6: + dependencies: + anymatch: 3.1.3 + chokidar: 5.0.0 + destr: 2.0.5 + h3: 1.15.11 + lru-cache: 11.5.3 + node-fetch-native: 1.6.7 + ofetch: 1.5.1 + ufo: 1.6.4 + + url-extras@0.1.0: {} + + util-deprecate@1.0.2: {} + + verkit@0.5.0: {} + + vfile-location@5.0.4: + dependencies: + '@types/unist': 3.0.3 + vfile: 6.0.3 + + vfile-message@4.0.4: + dependencies: + '@types/unist': 3.0.3 + unist-util-stringify-position: 4.0.0 + + vfile@6.0.3: + dependencies: + '@types/unist': 3.0.3 + vfile-message: 4.0.4 + + vite@8.3.8(@types/node@26.6.6)(yaml@2.9.1): + dependencies: + lightningcss: 1.33.0 + picomatch: 4.0.7 + postcss: 8.5.33 + rolldown: 1.2.19 + tinyglobby: 0.2.17 + optionalDependencies: + '@types/node': 26.6.6 + fsevents: 2.3.3 + yaml: 2.9.1 + + vitefu@1.1.3(vite@8.3.8(@types/node@26.6.6)(yaml@2.9.1)): + optionalDependencies: + vite: 8.3.8(@types/node@26.6.6)(yaml@2.9.1) + + web-namespaces@2.0.1: {} + + xxhash-wasm@1.1.0: {} + + yaml@2.9.1: {} + + yocto-queue@1.2.2: {} + + zod@4.6.7: {} + + zwitch@2.0.4: {} diff --git a/site/pnpm-workspace.yaml b/site/pnpm-workspace.yaml new file mode 100644 index 000000000..effdc849c --- /dev/null +++ b/site/pnpm-workspace.yaml @@ -0,0 +1,4 @@ +# Astro's optional image optimizer (sharp, with libvips under LGPL-3.0-or-later) is not +# installed: the site has no images to optimize and uses Astro's passthrough image service. +overrides: + sharp: '-' diff --git a/site/src/content.config.ts b/site/src/content.config.ts new file mode 100644 index 000000000..54d803ac0 --- /dev/null +++ b/site/src/content.config.ts @@ -0,0 +1,9 @@ +import { defineCollection } from 'astro:content'; +import { docsLoader } from '@astrojs/starlight/loaders'; +import { docsSchema } from '@astrojs/starlight/schema'; + +// The pages are generated from ../docs by ../scripts/docs_site_content.py +// (run by the `orcapod-docs-content` integration in astro.config.mjs). +export const collections = { + docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), +}; From 4a43732efc5c0fa25feac970dd047091149085b0 Mon Sep 17 00:00:00 2001 From: "Edgar Y. Walker" <> Date: Mon, 16 Nov 2026 16:26:37 -0800 Subject: [PATCH 02/10] docs(site)!: publish the documentation as a Starlight site; remove mkdocs (ITL-1170) The site under site/ is built from docs/ by scripts/docs_site_content.py (titles, admonitions, links and anchors converted; a broken link, an unpublished page or a new unclassified docs/ folder fails the build) and its API reference is generated from the source with griffe (scripts/docs_site_api.py). starlight-links-validator checks every link and anchor. docs-site.yml builds it on every pull request and publishes it to GitHub Pages from nauticalab/orcapod-python. mkdocs.yml, the mkdocs dev dependencies and test_mkdocs_build.py are removed; test_site_content.py covers the content build without Node. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --- .github/workflows/docs-site.yml | 106 ++++++++++ .zed/rules | 28 ++- CLAUDE.md | 28 ++- changelog.d/ITL-1170.md | 8 + docs/api/databases.md | 6 + docs/api/function-pods.md | 6 + docs/api/nodes.md | 6 + docs/api/operators.md | 6 + docs/api/pipeline.md | 6 + docs/api/sources.md | 6 + docs/api/streams.md | 6 + docs/api/types.md | 6 + mkdocs.yml | 74 ------- pyproject.toml | 5 +- scripts/check_site_licenses.py | 73 +++++++ scripts/docs_site_api.py | 240 +++++++++++---------- scripts/docs_site_content.py | 172 ++++++++++----- site/README.md | 72 +++++++ site/astro.config.mjs | 4 +- site/package.json | 2 + site/pnpm-lock.yaml | 167 +++++++++++++++ tests/test_docs/test_mkdocs_build.py | 48 ----- tests/test_docs/test_site_content.py | 305 +++++++++++++++++++++++++++ uv.lock | 248 +--------------------- 24 files changed, 1089 insertions(+), 539 deletions(-) create mode 100644 .github/workflows/docs-site.yml create mode 100644 changelog.d/ITL-1170.md delete mode 100644 mkdocs.yml create mode 100644 scripts/check_site_licenses.py create mode 100644 site/README.md delete mode 100644 tests/test_docs/test_mkdocs_build.py create mode 100644 tests/test_docs/test_site_content.py diff --git a/.github/workflows/docs-site.yml b/.github/workflows/docs-site.yml new file mode 100644 index 000000000..25fcae164 --- /dev/null +++ b/.github/workflows/docs-site.yml @@ -0,0 +1,106 @@ +name: Documentation site + +# Builds the documentation site (site/, Astro Starlight) from docs/ and the source on every +# pull request and push, so a broken page, link, anchor or docstring fails CI (ITL-1170). +# The public repository publishes it to GitHub Pages, https://nauticalab.github.io/orcapod-python/ +# (the base path is set in site/astro.config.mjs): when `main` is pushed there (a release +# point, see RELEASING.md) or by hand (Run workflow). The development repository only builds. + +on: + push: + branches: [main] + pull_request: + workflow_dispatch: + +env: + # The one repository that publishes the site. + PAGES_REPOSITORY: nauticalab/orcapod-python + +permissions: + contents: read + +concurrency: + group: docs-site-${{ github.ref }} + cancel-in-progress: true + +jobs: + build: + name: Build the site + runs-on: ubuntu-latest + timeout-minutes: 20 + outputs: + publish: ${{ steps.publish.outputs.publish }} + steps: + - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + fetch-depth: 0 # required: hatch-vcs needs full tag history + + - name: Install uv + uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1 + + - name: Set up Python 3.11 + uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 + with: + python-version: "3.11" + + - name: Install Python dependencies + run: uv sync --locked --dev --python "3.11" + + - name: Install pnpm + # The version is the packageManager field of site/package.json. + uses: pnpm/action-setup@73e46992e05b19abd31f2f3c20e0e7370d762115 # v6.1.1 + with: + package_json_file: site/package.json + + - name: Set up Node + # The version is the engines.node field of site/package.json. + uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0 + with: + node-version-file: site/package.json + cache: pnpm + cache-dependency-path: site/pnpm-lock.yaml + + - name: Install site dependencies + working-directory: site + run: pnpm install --frozen-lockfile + + - name: Check site dependency licenses + working-directory: site + run: pnpm licenses list --json --prod | uv run python ../scripts/check_site_licenses.py + + - name: Build the site + working-directory: site + run: pnpm build + + - name: Decide whether to publish + id: publish + run: echo "publish=${{ github.repository == env.PAGES_REPOSITORY && github.event_name != 'pull_request' }}" >> "$GITHUB_OUTPUT" + + - name: Upload the site for GitHub Pages + if: steps.publish.outputs.publish == 'true' + uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 + with: + path: site/dist + + deploy: + name: Publish to GitHub Pages + needs: build + if: needs.build.outputs.publish == 'true' + runs-on: ubuntu-latest + timeout-minutes: 10 + permissions: + pages: write + id-token: write + concurrency: + group: pages + cancel-in-progress: false + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Configure GitHub Pages + uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0 + + - name: Deploy + id: deployment + uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1 diff --git a/.zed/rules b/.zed/rules index 3f2be1038..2b4d86fac 100644 --- a/.zed/rules +++ b/.zed/rules @@ -82,8 +82,7 @@ other ReST cross-reference roles. Use plain ``backtick`` notation to refer to na Every fenced python block in README.md, docs/index.md, docs/getting-started.md, docs/troubleshooting.md, docs/concepts/, docs/reference/ and docs/tutorial/ is executed by -tests/test_docs/test_doc_samples.py, and tests/test_docs/test_mkdocs_build.py runs -mkdocs build --strict. When writing docs: +tests/test_docs/test_doc_samples.py. When writing docs: - Blocks on one page share a namespace and run top to bottom. - Every line a block prints must appear as a "# ..." comment in that block; "..." inside the @@ -99,6 +98,31 @@ mkdocs build --strict. When writing docs: - Output that the library does not guarantee to be ordered must not be shown as if it were: print sorted(job.nodes), and sort rows read back from a database before showing them. +## Documentation site + +The documentation is published as an Astro Starlight site, built from docs/ (developer, +November 16, 2026, ITL-1170; site/README.md has the commands). mkdocs is gone. + +- docs/ is the only source. scripts/docs_site_content.py writes the site's pages + (site/src/content/docs/, site/public/, both ignored by git) on every build: never edit or + commit them, and never copy page text into site/. +- Write pages as before: a "# <title>" first line, mkdocs-style admonitions + (!!! note "Title", ??? success "Solution") and relative .md links; the script converts + them. A link to a missing or unpublished page or file fails the build, and the site build + validates every link and anchor. +- What is published is decided in scripts/docs_site_content.py (PUBLISHED_FILES, + PUBLISHED_FOLDERS, EXCLUDED). A new top-level entry under docs/ fails the build until it is + added to one of them; docs/dev/ is never published. +- The API reference is generated from the source by scripts/docs_site_api.py (griffe). + docs/api/*.md are its input: an introduction and one "::: <object path>" line per object; + never write a signature or a docstring there. A docstring griffe warns about (an Args: + entry the signature does not have) fails the build. +- Build locally with "cd site && pnpm install && pnpm build"; CI builds the site on every pull + request (.github/workflows/docs-site.yml) and tests/test_docs/test_site_content.py runs the + content build without Node. The public repository publishes it to GitHub Pages + (https://nauticalab.github.io/orcapod-python/); the repository that publishes is named once, + in that workflow. + ## Linear issue tracking All work must be linked to a Linear issue. Before starting any feature, bug fix, or diff --git a/CLAUDE.md b/CLAUDE.md index f5adb0c8b..5205b66f3 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -86,8 +86,7 @@ to refer to names (e.g. ``PollingSource``, ``iter_data``, ``CursorInvalidatedErr Every fenced `python` block in `README.md`, `docs/index.md`, `docs/getting-started.md`, `docs/troubleshooting.md`, `docs/concepts/`, `docs/reference/` and `docs/tutorial/` is executed -by `tests/test_docs/test_doc_samples.py`, and `tests/test_docs/test_mkdocs_build.py` runs -`mkdocs build --strict`. When writing docs: +by `tests/test_docs/test_doc_samples.py`. When writing docs: - Blocks on one page share a namespace and run top to bottom. - Every line a block prints must appear as a `# ...` comment in that block; `...` inside the @@ -103,6 +102,31 @@ by `tests/test_docs/test_doc_samples.py`, and `tests/test_docs/test_mkdocs_build - Output that the library does not guarantee to be ordered must not be shown as if it were: print `sorted(job.nodes)`, and sort rows read back from a database before showing them. +## Documentation site + +The documentation is published as an Astro Starlight site, built from `docs/` (developer, +November 16, 2026, ITL-1170; `site/README.md` has the commands). mkdocs is gone. + +- `docs/` is the only source. `scripts/docs_site_content.py` writes the site's pages + (`site/src/content/docs/`, `site/public/`, both ignored by git) on every build: never + edit or commit them, and never copy page text into `site/`. +- Write pages as before: a `# <title>` first line, mkdocs-style admonitions (`!!! note "Title"`, + `??? success "Solution"`) and relative `.md` links; the script converts them. A link to a + missing or unpublished page or file fails the build, and the site build validates every + link and anchor. +- What is published is decided in `scripts/docs_site_content.py` (`PUBLISHED_FILES`, + `PUBLISHED_FOLDERS`, `EXCLUDED`). A new top-level entry under `docs/` fails the build until + it is added to one of them; `docs/dev/` is never published. +- The API reference is generated from the source by `scripts/docs_site_api.py` (griffe). + `docs/api/*.md` are its input: an introduction and one `::: <object path>` line per object; + never write a signature or a docstring there. A docstring griffe warns about (an `Args:` + entry the signature does not have) fails the build. +- Build locally with `cd site && pnpm install && pnpm build`; CI builds the site on every pull + request (`.github/workflows/docs-site.yml`) and `tests/test_docs/test_site_content.py` runs + the content build without Node. The public repository publishes it to GitHub Pages + (`https://nauticalab.github.io/orcapod-python/`); the repository that publishes is named + once, in that workflow. + ## Linear issue tracking All work must be linked to a Linear issue. Before starting any feature, bug fix, or diff --git a/changelog.d/ITL-1170.md b/changelog.d/ITL-1170.md new file mode 100644 index 000000000..d86740796 --- /dev/null +++ b/changelog.d/ITL-1170.md @@ -0,0 +1,8 @@ +### Changed + +- The documentation is built as an [Astro Starlight](https://starlight.astro.build) site + from `docs/` and published to GitHub Pages at + <https://nauticalab.github.io/orcapod-python/>. Its API reference is generated from the + source code on every build. mkdocs, mkdocs-material and mkdocstrings are no longer + development dependencies; `griffelib` is. Building the site needs Node and pnpm + (`site/README.md`). (ITL-1170) diff --git a/docs/api/databases.md b/docs/api/databases.md index 728a14e7b..4387b75c1 100644 --- a/docs/api/databases.md +++ b/docs/api/databases.md @@ -1,4 +1,10 @@ # Databases +<!-- +Input of the API reference generator (scripts/docs_site_api.py), not a page written by +hand: this file chooses the objects (one `::: <object path>` line each) and gives the +introduction. Every signature and docstring on the published page comes from the source +code. See site/README.md. +--> Database backends for persistent storage of pipeline computation results. diff --git a/docs/api/function-pods.md b/docs/api/function-pods.md index 07e64163f..6931a095b 100644 --- a/docs/api/function-pods.md +++ b/docs/api/function-pods.md @@ -1,4 +1,10 @@ # Function Pods +<!-- +Input of the API reference generator (scripts/docs_site_api.py), not a page written by +hand: this file chooses the objects (one `::: <object path>` line each) and gives the +introduction. Every signature and docstring on the published page comes from the source +code. See site/README.md. +--> Function pods wrap Python functions to transform individual data in a stream. diff --git a/docs/api/nodes.md b/docs/api/nodes.md index f3d96f3a1..1b46f76d7 100644 --- a/docs/api/nodes.md +++ b/docs/api/nodes.md @@ -1,4 +1,10 @@ # Nodes +<!-- +Input of the API reference generator (scripts/docs_site_api.py), not a page written by +hand: this file chooses the objects (one `::: <object path>` line each) and gives the +introduction. Every signature and docstring on the published page comes from the source +code. See site/README.md. +--> Nodes are the elements of a compiled pipeline graph. The plain node classes describe the graph of a `Pipeline` blueprint; the job node classes below add database-backed execution. diff --git a/docs/api/operators.md b/docs/api/operators.md index 8421cfa9e..f3fad9a5d 100644 --- a/docs/api/operators.md +++ b/docs/api/operators.md @@ -1,4 +1,10 @@ # Operators +<!-- +Input of the API reference generator (scripts/docs_site_api.py), not a page written by +hand: this file chooses the objects (one `::: <object path>` line each) and gives the +introduction. Every signature and docstring on the published page comes from the source +code. See site/README.md. +--> Operators perform structural transformations on streams without inspecting or synthesizing data values. diff --git a/docs/api/pipeline.md b/docs/api/pipeline.md index c4aa7bd12..c64646ac8 100644 --- a/docs/api/pipeline.md +++ b/docs/api/pipeline.md @@ -1,4 +1,10 @@ # Pipeline +<!-- +Input of the API reference generator (scripts/docs_site_api.py), not a page written by +hand: this file chooses the objects (one `::: <object path>` line each) and gives the +introduction. Every signature and docstring on the published page comes from the source +code. See site/README.md. +--> Top-level objects for composing and executing Orcapod data pipelines. `Pipeline` is a pure blueprint; `PipelineJob` binds a pipeline to sources and a database and runs it. diff --git a/docs/api/sources.md b/docs/api/sources.md index 0e8218e03..e24f43bb9 100644 --- a/docs/api/sources.md +++ b/docs/api/sources.md @@ -1,4 +1,10 @@ # Sources +<!-- +Input of the API reference generator (scripts/docs_site_api.py), not a page written by +hand: this file chooses the objects (one `::: <object path>` line each) and gives the +introduction. Every signature and docstring on the published page comes from the source +code. See site/README.md. +--> Source classes provide the entry point for external data into Orcapod pipelines. All sources convert their input to a PyArrow Table and use `SourceStreamBuilder` for diff --git a/docs/api/streams.md b/docs/api/streams.md index 98a8635e8..446229075 100644 --- a/docs/api/streams.md +++ b/docs/api/streams.md @@ -1,4 +1,10 @@ # Streams +<!-- +Input of the API reference generator (scripts/docs_site_api.py), not a page written by +hand: this file chooses the objects (one `::: <object path>` line each) and gives the +introduction. Every signature and docstring on the published page comes from the source +code. See site/README.md. +--> Streams are immutable sequences of (Tag, Data) pairs backed by PyArrow tables. diff --git a/docs/api/types.md b/docs/api/types.md index 4dcc76a33..62b736584 100644 --- a/docs/api/types.md +++ b/docs/api/types.md @@ -1,4 +1,10 @@ # Types +<!-- +Input of the API reference generator (scripts/docs_site_api.py), not a page written by +hand: this file chooses the objects (one `::: <object path>` line each) and gives the +introduction. Every signature and docstring on the published page comes from the source +code. See site/README.md. +--> Core type definitions used throughout Orcapod. diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index 412aa3a5a..000000000 --- a/mkdocs.yml +++ /dev/null @@ -1,74 +0,0 @@ -site_name: Orcapod -site_description: Intuitive and powerful library for highly reproducible scientific data pipelines - -theme: - name: material - features: - - navigation.tabs - - navigation.sections - - navigation.expand - - search.suggest - - content.code.copy - -plugins: - - search - - mkdocstrings: - handlers: - python: - paths: [src] - options: - docstring_style: google - show_source: true - show_bases: true - members_order: source - -markdown_extensions: - - admonition - - pymdownx.highlight - - pymdownx.superfences - - pymdownx.details - - toc: - permalink: true - -nav: - - Home: index.md - - Getting Started: getting-started.md - - Tutorial: - - Overview: tutorial/index.md - - 0. Setup: tutorial/00-setup.md - - 1. Your first stream: tutorial/01-first-stream.md - - 2. Computing with function pods: tutorial/02-function-pods.md - - 3. Reshaping with operators: tutorial/03-operators.md - - 4. Many rows into one: tutorial/04-many-rows-into-one.md - - 5. Keeping results: tutorial/05-pipeline-job.md - - 6. Re-runs and caching: tutorial/06-reruns-and-caching.md - - 7. Working with files: tutorial/07-files.md - - 8. Inspecting and tracing: tutorial/08-inspecting-and-tracing.md - - 9. When things go wrong: tutorial/09-when-things-go-wrong.md - - 10. Where next: tutorial/10-where-next.md - - Concepts: - - Sources: concepts/sources.md - - Streams: concepts/streams.md - - Operators: concepts/operators.md - - Function Pods: concepts/function-pods.md - - Pipelines and Jobs: concepts/pipeline-job.md - - Your Own Data Types: concepts/your-own-data-types.md - - Arrays and Tensors: concepts/arrays.md - - Logical Type Identifiers: concepts/logical-type-identifiers.md - - Identity & Hashing: concepts/identity.md - - File and Path Types: concepts/file-types.md - - File Hash Caching: concepts/file-hash-caching.md - - API Reference: - - Overview: api/index.md - - Sources: api/sources.md - - Streams: api/streams.md - - Operators: api/operators.md - - Function Pods: api/function-pods.md - - Databases: api/databases.md - - Nodes: api/nodes.md - - Pipeline: api/pipeline.md - - Types: api/types.md - - Reference: - - Hashing: reference/hashing.md - - Golden hashes: reference/golden-hashes.md - - Troubleshooting: troubleshooting.md diff --git a/pyproject.toml b/pyproject.toml index d23e2fc83..209979d97 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -107,8 +107,9 @@ dev = [ "pip-licenses>=5.0.0", "tqdm>=4.67.1", "typing_extensions", - "mkdocs-material>=9.7.5", - "mkdocstrings[python]>=1.0.3", + # The API reference of the documentation site is generated with griffe + # (scripts/docs_site_api.py). + "griffelib>=2.0.2", # torch for the torch.Tensor tests: the default `uv run` sync (the org-required pytest # and typecheck jobs) installs the dev group but no extras (ITL-871). "orcapod[torch]", diff --git a/scripts/check_site_licenses.py b/scripts/check_site_licenses.py new file mode 100644 index 000000000..984f7e26c --- /dev/null +++ b/scripts/check_site_licenses.py @@ -0,0 +1,73 @@ +"""Check the licenses of the documentation site's npm packages. + +The Python dependencies are checked by ``.github/workflows/_license-check.yml`` +(``pip-licenses``). The site under ``site/`` is built with npm packages; this script +checks them against the same allow list, plus the permissive licenses only npm packages +use (``BlueOak-1.0.0``, ``CC0-1.0``). + +Usage (the ``docs-site`` workflow runs it): + + cd site && pnpm licenses list --json --prod | uv run python ../scripts/check_site_licenses.py + +The script uses the standard library only. +""" + +from __future__ import annotations + +import json +import sys +from typing import cast + +# The license identifiers allowed, as in _license-check.yml, plus BlueOak-1.0.0 and +# CC0-1.0. +ALLOWED = frozenset( + { + "MIT", + "Apache-2.0", + "BSD-2-Clause", + "BSD-3-Clause", + "ISC", + "LGPL-3.0-only", + "MPL-2.0", + "Python-2.0", + "PSF-2.0", + "Unlicense", + "BlueOak-1.0.0", + "CC0-1.0", + } +) + + +def disallowed(report: dict[str, list[dict[str, str | list[str]]]]) -> list[str]: + """Return ``"<package>@<versions>: <license>"`` for every package not allowed. + + Args: + report: The output of ``pnpm licenses list --json``: license identifier to + the packages under it. + """ + problems: list[str] = [] + for license_id, packages in report.items(): + if license_id in ALLOWED: + continue + for package in packages: + versions = package.get("versions", []) + listed = ",".join(versions) if isinstance(versions, list) else versions + problems.append(f"{package['name']}@{listed}: {license_id}") + return sorted(problems) + + +def main() -> int: + report = cast(dict[str, list[dict[str, str | list[str]]]], json.load(sys.stdin)) + problems = disallowed(report) + if problems: + print("npm packages under a license that is not allowed:", file=sys.stderr) + for problem in problems: + print(f" {problem}", file=sys.stderr) + return 1 + count = sum(len(packages) for packages in report.values()) + print(f"{count} npm packages, all under allowed licenses") + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/scripts/docs_site_api.py b/scripts/docs_site_api.py index 4fe543ed4..1432d6265 100644 --- a/scripts/docs_site_api.py +++ b/scripts/docs_site_api.py @@ -29,16 +29,16 @@ import logging import re -from collections.abc import Iterator, Sequence +from collections.abc import Iterator from dataclasses import dataclass, field from functools import cache from pathlib import Path import griffe +from typing_extensions import override REPO_ROOT = Path(__file__).resolve().parents[1] SOURCE_DIR = REPO_ROOT / "src" -API_DIR = REPO_ROOT / "docs" / "api" PACKAGE = "orcapod" _DIRECTIVE = re.compile(r"^::: +(?P<path>[\w.]+) *$") @@ -68,6 +68,7 @@ def __init__(self) -> None: super().__init__(level=logging.WARNING) self.problems: list[str] = [] + @override def emit(self, record: logging.LogRecord) -> None: self.problems.append(record.getMessage()) @@ -102,52 +103,60 @@ def _directives(text: str) -> Iterator[str]: yield match.group("path") -def _lookup(path: str) -> griffe.Object | griffe.Alias: +def _real(obj: griffe.Object | griffe.Alias) -> griffe.Object: + """The object itself, for an alias (a re-export) the object it names.""" + return obj.final_target if isinstance(obj, griffe.Alias) else obj + + +def _lookup(path: str) -> griffe.Object: package = _package() if not path.startswith(PACKAGE + "."): raise ApiPageError(f"::: {path}: not an object of the {PACKAGE} package") try: - return package[path.removeprefix(PACKAGE + ".")] + found: griffe.Object | griffe.Alias = package[path.removeprefix(PACKAGE + ".")] except KeyError: raise ApiPageError(f"::: {path}: no such object") from None + return _real(found) def _page_url(page: str, base: str) -> str: - return f"{base.rstrip('/')}/api/{page}/" if page != "index" else f"{base.rstrip('/')}/api/" + return ( + f"{base.rstrip('/')}/api/{page}/" + if page != "index" + else f"{base.rstrip('/')}/api/" + ) @cache -def _index(base: str) -> _Index: +def _index(api_dir: Path, base: str) -> _Index: """Index every object documented on any API page (and its documented members).""" index = _Index() - for page_file in sorted(API_DIR.glob("*.md")): + for page_file in sorted(api_dir.glob("*.md")): url = _page_url(page_file.stem, base) for path in _directives(page_file.read_text(encoding="utf-8")): obj = _lookup(path) for anchor, member in _anchored(path, obj): target = f"{url}#{anchor}" - index.urls.setdefault(anchor, target) - index.urls.setdefault(member.canonical_path, target) + _ = index.urls.setdefault(anchor, target) + _ = index.urls.setdefault(member.canonical_path, target) return index -def _members(obj: griffe.Object | griffe.Alias) -> list[griffe.Object | griffe.Alias]: +def _members(obj: griffe.Object) -> list[griffe.Object]: """The members shown for ``obj``: public, documented, declared on it, in order.""" - if not obj.is_class: + if not isinstance(obj, griffe.Class): return [] - shown = [] - for name, member in obj.members.items(): - if name.startswith("_") or not member.docstring: - continue - if member.is_alias and member.inherited: - continue - shown.append(member) + shown = [ + member + for name, member in obj.members.items() + if not name.startswith("_") + and not isinstance(member, griffe.Alias) + and member.docstring + ] return sorted(shown, key=lambda m: m.lineno or 0) -def _anchored( - path: str, obj: griffe.Object | griffe.Alias -) -> Iterator[tuple[str, griffe.Object | griffe.Alias]]: +def _anchored(path: str, obj: griffe.Object) -> Iterator[tuple[str, griffe.Object]]: yield path, obj for member in _members(obj): yield f"{path}.{member.name}", member @@ -190,10 +199,13 @@ def _code(text: str) -> str: return f"{ticks}{pad}{text}{pad}{ticks}" -def _parameters(obj: griffe.Object | griffe.Alias) -> list[griffe.Parameter]: - if obj.is_class: +def _parameters(obj: griffe.Class | griffe.Function) -> list[griffe.Parameter]: + if isinstance(obj, griffe.Class): init = obj.all_members.get("__init__") - if init is None or not init.is_function: + if init is None: + return [] + init = _real(init) + if not isinstance(init, griffe.Function): return [] params = list(init.parameters) else: @@ -203,12 +215,17 @@ def _parameters(obj: griffe.Object | griffe.Alias) -> list[griffe.Parameter]: return params -def _signature(name: str, obj: griffe.Object | griffe.Alias) -> str: +_STARS = { + griffe.ParameterKind.var_positional: "*", + griffe.ParameterKind.var_keyword: "**", +} + + +def _signature(name: str, obj: griffe.Class | griffe.Function) -> str: """Render the signature of a class or function as a Python code block.""" - prefix = "" - if obj.is_class: + if isinstance(obj, griffe.Class): prefix = "class " - elif obj.is_function: + else: prefix = "async def " if "async" in obj.labels else "def " params = _parameters(obj) rendered: list[str] = [] @@ -229,21 +246,22 @@ def _signature(name: str, obj: griffe.Object | griffe.Alias) -> str: and kind is not griffe.ParameterKind.positional_only ): rendered.append("/") - star = { - griffe.ParameterKind.var_positional: "*", - griffe.ParameterKind.var_keyword: "**", - }.get(kind, "") + star = _STARS.get(kind, "") if kind is not None else "" text = f"{star}{param.name}" if param.annotation is not None: text += f": {param.annotation}" - if param.default is not None: - text += f" = {param.default}" if param.annotation is not None else f"={param.default}" + if param.default is not None and not star: + text += ( + f" = {param.default}" + if param.annotation is not None + else f"={param.default}" + ) rendered.append(text) previous_kind = kind if previous_kind is griffe.ParameterKind.positional_only: rendered.append("/") returns = "" - if obj.is_function and obj.returns is not None: + if isinstance(obj, griffe.Function) and obj.returns is not None: returns = f" -> {obj.returns}" one_line = f"{prefix}{name}({', '.join(rendered)}){returns}" if len(one_line) <= _SIGNATURE_WIDTH or not rendered: @@ -257,73 +275,86 @@ def _signature(name: str, obj: griffe.Object | griffe.Alias) -> str: def _indent_continuation(text: str) -> str: """Indent every line after the first by two spaces, for a list item.""" lines = text.strip().splitlines() - return "\n".join([lines[0], *(" " + ln if ln else "" for ln in lines[1:])]) if lines else "" + return ( + "\n".join([lines[0], *(" " + ln if ln else "" for ln in lines[1:])]) + if lines + else "" + ) + + +_ELEMENT_SECTIONS: tuple[tuple[type[griffe.DocstringSection], str, bool], ...] = ( + # (section class, title, whether its items have a name to show) + (griffe.DocstringSectionParameters, "Parameters", True), + (griffe.DocstringSectionOtherParameters, "Other parameters", True), + (griffe.DocstringSectionAttributes, "Attributes", True), + (griffe.DocstringSectionReturns, "Returns", True), + (griffe.DocstringSectionYields, "Yields", True), + (griffe.DocstringSectionReceives, "Receives", True), + (griffe.DocstringSectionRaises, "Raises", False), + (griffe.DocstringSectionWarns, "Warns", False), +) + + +def _element_item( + element: griffe.DocstringElement, show_name: bool, index: _Index +) -> str: + """One item of a parameters / returns / raises ... list.""" + head_parts: list[str] = [] + if show_name and isinstance(element, griffe.DocstringNamedElement) and element.name: + head_parts.append(f"**{element.name}**") + annotation = _annotation(element.annotation, index) + if annotation: + head_parts.append(f"({annotation})" if head_parts else annotation) + if isinstance(element, griffe.DocstringParameter) and element.default is not None: + head_parts.append(f"default {_code(str(element.default))}") + head = " ".join(head_parts) + description = _indent_continuation(element.description or "") + return f"- {head}: {description}" if head else f"- {description}" def _section(section: griffe.DocstringSection, index: _Index) -> str: - kind = section.kind - value = section.value - if kind is griffe.DocstringSectionKind.text: - return str(value).strip() - if kind is griffe.DocstringSectionKind.admonition: - admonition: griffe.DocstringAdmonition = value - title = section.title or admonition.annotation or "" - aside = _ASIDES.get(str(admonition.annotation or title).lower(), "note") + """Render one parsed docstring section as Markdown. + + Raises: + ApiPageError: For a section kind this generator does not render. + """ + if isinstance(section, griffe.DocstringSectionText): + return section.value.strip() + if isinstance(section, griffe.DocstringSectionAdmonition): + admonition: griffe.DocstringAdmonition = section.value + kind = str(admonition.annotation or "") + title = section.title or kind.capitalize() + aside = _ASIDES.get(kind.lower(), "note") return f":::{aside}[{title}]\n{admonition.description.strip()}\n:::" - if kind is griffe.DocstringSectionKind.examples: - out: list[str] = [] - for example_kind, text in value: - if example_kind is griffe.DocstringSectionKind.examples or str( - example_kind - ).endswith("examples"): - out.append(f"```pycon\n{text}\n```") - else: - out.append(str(text).strip()) - return "**Examples:**\n\n" + "\n\n".join(out) - titles = { - griffe.DocstringSectionKind.parameters: "Parameters", - griffe.DocstringSectionKind.other_parameters: "Other parameters", - griffe.DocstringSectionKind.attributes: "Attributes", - griffe.DocstringSectionKind.returns: "Returns", - griffe.DocstringSectionKind.yields: "Yields", - griffe.DocstringSectionKind.receives: "Receives", - griffe.DocstringSectionKind.raises: "Raises", - griffe.DocstringSectionKind.warns: "Warns", - } - if kind in titles: - items = [] - for element in value: - name = getattr(element, "name", "") or "" - annotation = _annotation(getattr(element, "annotation", None), index) - head_parts = [] - if name and kind not in ( - griffe.DocstringSectionKind.raises, - griffe.DocstringSectionKind.warns, - ): - head_parts.append(f"**{name}**") - if annotation: - head_parts.append( - f"({annotation})" if head_parts else annotation - ) - default = getattr(element, "default", None) - if default is not None and kind is griffe.DocstringSectionKind.parameters: - head_parts.append(f"default {_code(str(default))}") - head = " ".join(head_parts) - description = _indent_continuation(element.description or "") - items.append(f"- {head}: {description}" if head else f"- {description}") - return f"**{titles[kind]}:**\n\n" + "\n".join(items) - if kind is griffe.DocstringSectionKind.deprecated: - return f":::caution[Deprecated {value.version or ''}]\n{value.description}\n:::" - raise ApiPageError(f"docstring section {kind.value!r} is not rendered") - - -def _docstring(obj: griffe.Object | griffe.Alias, index: _Index) -> str: + if isinstance(section, griffe.DocstringSectionExamples): + parts = [ + f"```python\n{text}\n```" + if kind is griffe.DocstringSectionKind.examples + else text.strip() + for kind, text in section.value + ] + return "**Examples:**\n\n" + "\n\n".join(parts) + if isinstance(section, griffe.DocstringSectionDeprecated): + deprecated: griffe.DocstringDeprecated = section.value + return ( + f":::caution[Deprecated {deprecated.version}]\n" + f"{deprecated.description.strip()}\n:::" + ) + for section_class, title, show_name in _ELEMENT_SECTIONS: + if isinstance(section, section_class): + elements: list[griffe.DocstringElement] = section.value # pyright: ignore[reportAny] -- each listed class types value as a list of elements + items = [_element_item(e, show_name, index) for e in elements] + return f"**{title}:**\n\n" + "\n".join(items) + raise ApiPageError(f"docstring section {section.kind.value!r} is not rendered") + + +def _docstring(obj: griffe.Object, index: _Index) -> str: if not obj.docstring: return "" return "\n\n".join(_section(s, index) for s in obj.docstring.parse()) -def _kind_label(obj: griffe.Object | griffe.Alias) -> str: +def _kind_label(obj: griffe.Object) -> str: labels = set(obj.labels) if obj.is_class: return "class" @@ -341,7 +372,7 @@ def _kind_label(obj: griffe.Object | griffe.Alias) -> str: def _render_object( - path: str, obj: griffe.Object | griffe.Alias, level: int, index: _Index + path: str, obj: griffe.Object, level: int, index: _Index ) -> list[str]: name = obj.name out = [ @@ -352,11 +383,11 @@ def _render_object( f"<small>{_kind_label(obj)} ยท <code>{obj.canonical_path}</code></small>", "", ] - if obj.is_class or obj.is_function: + if isinstance(obj, griffe.Class | griffe.Function): out += [_signature(name, obj), ""] - elif obj.is_attribute and obj.annotation is not None: + elif isinstance(obj, griffe.Attribute) and obj.annotation is not None: out += [f"Type: {_annotation(obj.annotation, index)}", ""] - if obj.is_class and obj.bases: + if isinstance(obj, griffe.Class) and obj.bases: bases = ", ".join(_annotation(b, index) for b in obj.bases) out += [f"Bases: {bases}", ""] doc = _docstring(obj, index) @@ -367,11 +398,13 @@ def _render_object( return out -def expand_api_page(text: str, base: str = "/") -> str: +def expand_api_page(text: str, api_dir: Path, base: str = "/") -> str: """Replace every ``::: <object path>`` line of an API page with its reference. Args: text: The page as written under ``docs/api/``. + api_dir: The ``docs/api/`` folder: the objects its pages name are the ones + a type in a signature or parameter list can link to. base: The site's base path, for links between API pages. Returns: @@ -381,7 +414,7 @@ def expand_api_page(text: str, base: str = "/") -> str: ApiPageError: If an object does not exist or griffe reports a problem with a docstring it renders. """ - index = _index(base) + index = _index(api_dir, base) collector = _ProblemCollector() logger = logging.getLogger("griffe") logger.addHandler(collector) @@ -399,12 +432,3 @@ def expand_api_page(text: str, base: str = "/") -> str: if collector.problems: raise ApiPageError("docstring problems:\n " + "\n ".join(collector.problems)) return "\n".join(out).rstrip("\n") + "\n" - - -def documented_paths() -> Sequence[str]: - """Every object path the API pages name, in page order (for tests).""" - return [ - path - for page in sorted(API_DIR.glob("*.md")) - for path in _directives(page.read_text(encoding="utf-8")) - ] diff --git a/scripts/docs_site_content.py b/scripts/docs_site_content.py index 8bcb2bf4d..302825716 100644 --- a/scripts/docs_site_content.py +++ b/scripts/docs_site_content.py @@ -37,29 +37,26 @@ import json import posixpath import re -import shutil import sys import unicodedata from collections.abc import Callable, Iterable, Sequence from dataclasses import dataclass from pathlib import Path +from typing import cast REPO_ROOT = Path(__file__).resolve().parents[1] DOCS_DIR = REPO_ROOT / "docs" SITE_DIR = REPO_ROOT / "site" -# The published pages, as glob patterns relative to ``docs/``. Everything else under -# ``docs/`` (developer material under ``docs/dev/``, the tutorial data generator) is not -# a page of the site. -PUBLISHED_PAGES = ( - "index.md", - "getting-started.md", - "troubleshooting.md", - "tutorial/*.md", - "concepts/*.md", - "reference/*.md", - "api/*.md", -) +# What the site publishes from ``docs/``: these top-level pages, and every ``*.md`` +# page directly inside these folders. +PUBLISHED_FILES = ("index.md", "getting-started.md", "troubleshooting.md") +PUBLISHED_FOLDERS = ("tutorial", "concepts", "reference", "api") +# What it never publishes: developer material. Every other top-level entry of ``docs/`` +# is an error, so that publishing a new folder (or not) is a decision. +# TODO(ITL-1169): design/, metamorphic/, plans/ and specs/ move under dev/ in the +# repository cleanup; drop them here when it lands. +EXCLUDED = ("dev", "design", "metamorphic", "plans", "specs") # mkdocs admonition types and the Starlight aside each becomes. ASIDE_TYPES = { @@ -76,6 +73,9 @@ } SKIP_MARKER = "<!-- docs-test: skip -->" +# A comment right below the title is a note to the page's authors (the API pages say +# that they are generator input); it is not shown. +_HEADER_COMMENT = re.compile(r"\A<!--.*?-->\n", re.DOTALL) _ADMONITION = re.compile( r'^(?P<indent> *)(?P<marker>!!!|\?\?\?\+?) +(?P<kind>[a-z]+)(?: +"(?P<title>[^"]*)")? *$' @@ -181,10 +181,37 @@ def page_url(path: str, base: str = "/") -> str: def published_paths(docs_dir: Path) -> list[str]: - """Return the published pages under ``docs_dir``, sorted, relative to it.""" - found: set[str] = set() - for pattern in PUBLISHED_PAGES: - found.update(p.relative_to(docs_dir).as_posix() for p in docs_dir.glob(pattern)) + """Return the published pages under ``docs_dir``, sorted, relative to it. + + Raises: + ContentError: If ``docs_dir`` holds a top-level entry that is neither published + nor excluded, or a published folder holds a folder. + """ + unknown = sorted( + entry.name + for entry in docs_dir.iterdir() + if not entry.name.startswith(".") + and entry.name not in (*PUBLISHED_FILES, *PUBLISHED_FOLDERS, *EXCLUDED) + ) + nested = sorted( + f"{folder}/{entry.name}" + for folder in PUBLISHED_FOLDERS + if (docs_dir / folder).is_dir() + for entry in (docs_dir / folder).iterdir() + if entry.is_dir() and not entry.name.startswith((".", "__")) + ) + if unknown or nested: + raise ContentError( + "docs/ holds entries that are neither published nor excluded: " + + ", ".join(unknown + nested) + + " (add each to PUBLISHED_FILES, PUBLISHED_FOLDERS or EXCLUDED in" + + " scripts/docs_site_content.py)" + ) + found = [name for name in PUBLISHED_FILES if (docs_dir / name).is_file()] + for folder in PUBLISHED_FOLDERS: + found += [ + p.relative_to(docs_dir).as_posix() for p in (docs_dir / folder).glob("*.md") + ] return sorted(found) @@ -273,14 +300,19 @@ def convert_admonitions(lines: Sequence[str]) -> list[str]: kind = match.group("kind") title = match.group("title") end = _admonition_body(lines, i + 1, indent) - body = [ - raw[indent + 4 :] if raw.strip() else "" for raw in lines[i + 1 : end] - ] + body = [raw[indent + 4 :] if raw.strip() else "" for raw in lines[i + 1 : end]] body = convert_admonitions(body) pad = " " * indent if match.group("marker").startswith("???"): summary = html.escape(title if title else kind.capitalize()) - block = [f"<details>", f"<summary>{summary}</summary>", "", *body, "", "</details>"] + block = [ + "<details>", + f"<summary>{summary}</summary>", + "", + *body, + "", + "</details>", + ] else: if kind not in ASIDE_TYPES: raise ContentError(f"admonition type {kind!r} has no Starlight aside") @@ -296,9 +328,7 @@ def convert_admonitions(lines: Sequence[str]) -> list[str]: return out -def _convert_link_targets( - line: str, resolve: Callable[[str], str] -) -> str: +def _convert_link_targets(line: str, resolve: Callable[[str], str]) -> str: """Rewrite the targets of inline links on ``line``, outside inline code spans.""" pieces: list[str] = [] pos = 0 @@ -326,11 +356,11 @@ class LinkResolver: """ def __init__(self, docs_dir: Path, pages: Iterable[Page], base: str) -> None: - self._docs_dir = docs_dir - self._anchors = { + self._docs_dir: Path = docs_dir + self._anchors: dict[str, dict[str, str]] = { p.path: heading_anchors(split_title(p.text)[1]) for p in pages } - self._base = base + self._base: str = base self.assets: set[str] = set() def _fragment(self, page: str, fragment: str) -> str: @@ -354,7 +384,9 @@ def resolve(self, page: str, target: str) -> str: raise ContentError(f"link {target!r} leaves docs/") if resolved.endswith(".md"): if resolved not in self._anchors: - raise ContentError(f"link {target!r}: {resolved} is not a published page") + raise ContentError( + f"link {target!r}: {resolved} is not a published page" + ) if fragment: fragment = self._fragment(resolved, fragment) return page_url(resolved, self._base) + sep + fragment @@ -371,6 +403,7 @@ def convert_page(page: Page, resolver: LinkResolver) -> str: ContentError: If the page cannot be converted. """ title, body = split_title(page.text) + body = _HEADER_COMMENT.sub("", body).lstrip("\n") lines = [line for line in body.splitlines() if line.strip() != SKIP_MARKER] lines = convert_admonitions(lines) lines = _map_lines_outside_code( @@ -388,8 +421,8 @@ def build_content( ) -> None: """Write the converted ``pages`` to ``out_dir`` and linked files to ``public_dir``. - Both directories are emptied first, so a page removed from ``docs/`` leaves the - site. + Each directory ends up holding exactly what this build writes, so a page removed + from ``docs/`` leaves the site. Raises: ContentError: If a page cannot be converted; its path is in the message. @@ -404,45 +437,72 @@ def build_content( converted[page.path] = convert_page(page, resolver) except ContentError as exc: raise ContentError(f"docs/{page.path}: {exc}") from exc - for directory in (out_dir, public_dir): - if directory.exists(): - shutil.rmtree(directory) - directory.mkdir(parents=True) - for path, text in converted.items(): - target = out_dir / path - target.parent.mkdir(parents=True, exist_ok=True) - target.write_text(text, encoding="utf-8") - for asset in sorted(resolver.assets): - target = public_dir / asset + _sync_tree(out_dir, {path: text.encode() for path, text in converted.items()}) + _sync_tree( + public_dir, + {asset: (docs_dir / asset).read_bytes() for asset in sorted(resolver.assets)}, + ) + + +def _sync_tree(directory: Path, files: dict[str, bytes]) -> None: + """Make ``directory`` hold exactly ``files``, writing only what changed. + + A file that is unchanged is not rewritten, so ``astro dev`` reloads only the + pages an edit changed. + """ + directory.mkdir(parents=True, exist_ok=True) + for existing in sorted(directory.rglob("*"), reverse=True): + rel = existing.relative_to(directory).as_posix() + if existing.is_file() and rel not in files: + existing.unlink() + elif existing.is_dir() and not any(existing.iterdir()): + existing.rmdir() + for rel, data in files.items(): + target = directory / rel + if target.is_file() and target.read_bytes() == data: + continue target.parent.mkdir(parents=True, exist_ok=True) - shutil.copyfile(docs_dir / asset, target) + _ = target.write_bytes(data) def main(argv: Sequence[str] | None = None) -> int: - parser = argparse.ArgumentParser(description=__doc__.splitlines()[0]) - parser.add_argument("--docs", type=Path, default=DOCS_DIR) - parser.add_argument( + parser = argparse.ArgumentParser( + description="Build the documentation site content." + ) + _ = parser.add_argument("--docs", type=Path, default=DOCS_DIR) + _ = parser.add_argument( "--out", type=Path, default=SITE_DIR / "src" / "content" / "docs" ) - parser.add_argument("--public", type=Path, default=SITE_DIR / "public") - parser.add_argument("--base", default="/") + _ = parser.add_argument("--public", type=Path, default=SITE_DIR / "public") + _ = parser.add_argument("--base", default="/") args = parser.parse_args(argv) + docs_dir = cast(Path, args.docs) + out_dir = cast(Path, args.out) + public_dir = cast(Path, args.public) + base = cast(str, args.base) + + # Run as a script, scripts/ is on sys.path; the API generator imports griffe, so + # it is imported only when the content is built. + from docs_site_api import ( # pyright: ignore[reportImplicitRelativeImport] + ApiPageError, + expand_api_page, + ) - from docs_site_api import expand_api_page # the API generator imports griffe - - docs_dir: Path = args.docs pages: list[Page] = [] - for path in published_paths(docs_dir): - text = (docs_dir / path).read_text(encoding="utf-8") - if path.startswith("api/"): - text = expand_api_page(text, base=args.base) - pages.append(Page(path, text)) try: - build_content(pages, docs_dir, args.out, args.public, args.base) + for path in published_paths(docs_dir): + text = (docs_dir / path).read_text(encoding="utf-8") + if path.startswith("api/"): + try: + text = expand_api_page(text, docs_dir / "api", base=base) + except ApiPageError as exc: + raise ContentError(f"docs/{path}: {exc}") from exc + pages.append(Page(path, text)) + build_content(pages, docs_dir, out_dir, public_dir, base) except ContentError as exc: print(f"error: {exc}", file=sys.stderr) return 1 - print(f"wrote {len(pages)} pages to {args.out}") + print(f"wrote {len(pages)} pages to {out_dir}") return 0 diff --git a/site/README.md b/site/README.md new file mode 100644 index 000000000..d5541e84c --- /dev/null +++ b/site/README.md @@ -0,0 +1,72 @@ +# The Orcapod documentation site + +An [Astro Starlight](https://starlight.astro.build) site, built from `../docs/` and the +source code. It is published at <https://nauticalab.github.io/orcapod-python/>. + +## Build and preview + +You need Node (the version in `engines.node` of `package.json`), pnpm (the version in +`packageManager`) and [uv](https://docs.astral.sh/uv/), with the repository's Python +environment (`uv sync --dev` at the repository root). + +```sh +cd site +pnpm install --frozen-lockfile # once, and after package.json or the lockfile changes +pnpm build # build the site into site/dist +pnpm preview # serve site/dist at http://localhost:4321/orcapod-python/ +pnpm dev # live preview while editing docs/ or the source +``` + +`pnpm build` fails on a broken link or anchor, a page that is neither published nor +excluded, an object an API page names that does not exist, or a docstring problem. +Search works in `pnpm preview`, not in `pnpm dev`. + +## How the site is made + +`docs/` is the only source of the pages: the documentation tests execute its samples as +they are. The site holds no copy in git. Before every `astro build` and `astro dev`, the +`orcapod-docs-content` integration in `astro.config.mjs` runs +`../scripts/docs_site_content.py`, which writes `src/content/docs/` and `public/` (both +ignored by git) from `docs/`: + +- the `# <title>` first line of a page becomes Starlight's `title` front matter; +- an admonition (`!!! note "Title"`) becomes a Starlight aside, `warning` becoming + `caution`; a collapsible one (`??? success "Solution"`) becomes a `<details>` block; +- a relative link to a page becomes the page's URL, an mkdocs-style anchor the anchor + Starlight gives the same heading, and a link to another file under `docs/` copies the + file into the site; +- the `<!-- docs-test: skip -->` markers of the sample tests are removed. + +Which parts of `docs/` are published is decided in that script (`PUBLISHED_FILES`, +`PUBLISHED_FOLDERS`, `EXCLUDED`); `docs/dev/` is never published. + +### The API reference + +The API pages are generated from the source on every build by +`../scripts/docs_site_api.py`, with [griffe](https://mkdocstrings.github.io/griffe/) +(static analysis: the package is not imported). Each `docs/api/*.md` file is the +generator's input: its title, an introduction, and one `::: <object path>` line per +object to document. Each such line becomes the object's signature, its Google-style +docstring (sections rendered, notes and warnings as asides), its base classes, and its +public documented members in source order. Every object has the anchor of its path +(`#orcapod.core.operators.Join`), and a type in a parameter list links to the object's +reference when that object is documented. + +Planned with the v0.4 content update (ITL-1170): API pages generated from each public +module's `__all__` instead of these lists. + +## What is committed + +`package.json`, `pnpm-lock.yaml` (exact versions), `pnpm-workspace.yaml`, +`astro.config.mjs` (site settings, base path, sidebar), `src/content.config.ts` and +this file. `node_modules/`, `dist/`, `.astro/`, `src/content/docs/` and `public/` are +generated. + +Astro's optional image optimizer, `sharp`, is not installed (`pnpm-workspace.yaml`): the +site has no images, and its `libvips` is under a license the project does not allow. + +## CI and publishing + +`.github/workflows/docs-site.yml` builds the site on every pull request and push, and +checks the npm packages' licenses (`../scripts/check_site_licenses.py`). On the public +repository, a push to `main` (a release) or a manual run publishes it to GitHub Pages. diff --git a/site/astro.config.mjs b/site/astro.config.mjs index 56481bd47..b49a43baa 100644 --- a/site/astro.config.mjs +++ b/site/astro.config.mjs @@ -2,7 +2,7 @@ import { spawnSync } from 'node:child_process'; import { watch } from 'node:fs'; import { fileURLToPath } from 'node:url'; -import { defineConfig } from 'astro/config'; +import { defineConfig, passthroughImageService } from 'astro/config'; import starlight from '@astrojs/starlight'; import starlightLinksValidator from 'starlight-links-validator'; @@ -58,6 +58,8 @@ export default defineConfig({ base, // mkdocs rendered '--' and quotes as written; so does the site. markdown: { smartypants: false }, + // sharp is not installed (pnpm-workspace.yaml): images are served as they are. + image: { service: passthroughImageService() }, integrations: [ orcapodDocsContent(), starlight({ diff --git a/site/package.json b/site/package.json index 2953e8d4e..175028d86 100644 --- a/site/package.json +++ b/site/package.json @@ -2,6 +2,8 @@ "name": "orcapod-docs-site", "private": true, "type": "module", + "description": "The Orcapod documentation site (Astro Starlight), built from ../docs. See README.md.", + "packageManager": "pnpm@12.21.0", "engines": { "node": ">=22.23.4" }, diff --git a/site/pnpm-lock.yaml b/site/pnpm-lock.yaml index ee25c4283..0824136da 100644 --- a/site/pnpm-lock.yaml +++ b/site/pnpm-lock.yaml @@ -1,3 +1,170 @@ +--- +lockfileVersion: '9.0' + +importers: + + .: + configDependencies: {} + packageManagerDependencies: + pnpm: + specifier: 12.21.0 + version: 12.21.0 + +packages: + + '@pnpm/exe.android-arm64@12.21.0': + resolution: {integrity: sha512-iaWidxR5B9NUBpwMznCQu1yUpKB6BjTY5BYX2lORj76VsfINdj8Z8XWSzSNrGI8qlxa28Jzdp5fiaspzOaJZlA==} + cpu: [arm64] + os: [android] + + '@pnpm/exe.android-x64@12.21.0': + resolution: {integrity: sha512-35e5v3wlwjIYxDywq+R6/z8CE4gLOEgRxt18yqz1tMRLmx2mnW+CFJI2Q8+srTNjn7gykXUC0x1k195JNikC5A==} + cpu: [x64] + os: [android] + + '@pnpm/exe.darwin-arm64@12.21.0': + resolution: {integrity: sha512-F5OyMX/6zLSowpTZEQRojbCmPS1Pq+fyRaIinslsIe6Glh3qbyQ52u+Fe0eEzSaRuIbWZkXmAAXSWh6Q5Wrlgg==} + cpu: [arm64] + os: [darwin] + + '@pnpm/exe.darwin-x64@12.21.0': + resolution: {integrity: sha512-EzpvcsaE6hrrgYeEiAFYd2rSgFybYyxXhkAY7K3y6Hg3loVfcyJ81hHczpFzi8lW5RXtUlFECRPZ8ZAMRFQYYg==} + cpu: [x64] + os: [darwin] + + '@pnpm/exe.freebsd-x64@12.21.0': + resolution: {integrity: sha512-wNjuEnmdLks4aayPu/QZWQ5tQM9Jn+odUp/vwQM8BXRYoulkTZhtZTHoD60N6mUdLWef1hgUeUh8llNGEUsimw==} + cpu: [x64] + os: [freebsd] + + '@pnpm/exe.linux-arm64-musl@12.21.0': + resolution: {integrity: sha512-Ceit9zn4g5ZqCJtx1fV8eJE7p8aeXMrGZ+Dc01vRqZLIUNgNeI+Ur0ruyqxtsnJx6rGADyXzohumxPLHjaJ5AQ==} + cpu: [arm64] + os: [linux] + libc: [musl] + + '@pnpm/exe.linux-arm64@12.21.0': + resolution: {integrity: sha512-4Oj/iF2TDCe2lcH0n4TupPR5sSdrNLclJB6xBElLMPCUOAvBhdf2rRlSaO5M4erJ6g4Fyy7YTXTpcmfFsKyxEA==} + cpu: [arm64] + os: [linux] + libc: [glibc] + + '@pnpm/exe.linux-ppc64@12.21.0': + resolution: {integrity: sha512-s2o7rdSDeUTBFsNqxptpZXlTgT6cojmMVUOvTQvFNSv6Easian02ha4tR32fwwD97Au4YzIIjMCwywCF4D82Sw==} + cpu: [ppc64] + os: [linux] + libc: [glibc] + + '@pnpm/exe.linux-riscv64@12.21.0': + resolution: {integrity: sha512-EYv3GzxeBTITCuM3yGHHbpRFpUvyulkXpQ6LsjKAQNL3iaba1E6h9iDmlouLb3Io4AMMsfdk0/uG6poQ41uewA==} + cpu: [riscv64] + os: [linux] + libc: [glibc] + + '@pnpm/exe.linux-s390x@12.21.0': + resolution: {integrity: sha512-8VXGNGVNEfs7pL9GTZOzFxjFEnMt4WL3rLOADR5/kPQ7ROTV9GfpVI2DPO/zArXFSkvfc9Zad/WypHLbvzoaTQ==} + cpu: [s390x] + os: [linux] + libc: [glibc] + + '@pnpm/exe.linux-x64-musl@12.21.0': + resolution: {integrity: sha512-MnC5vpIXYubhDZCgCwlfJMg7Cg6HupN2IuouT9gD/tUmOfVdQYqeyYccWbthyo/Jeto8de1oQlxeRN1+1Hl2DQ==} + cpu: [x64] + os: [linux] + libc: [musl] + + '@pnpm/exe.linux-x64@12.21.0': + resolution: {integrity: sha512-8eufCjHXspKbNS/kh8q4Q0gqJoOuvC4Q5pgos6XS8By/nAMtP+jf8F1Cw9er840kfAX+PJ/ts+A9qnLE91rvXQ==} + cpu: [x64] + os: [linux] + libc: [glibc] + + '@pnpm/exe.netbsd-x64@12.21.0': + resolution: {integrity: sha512-eyh1M8hQZCkLWxuva7S/fc1SbFbgqg0/5di0dgWmyiuc2Io3dbWVihDun8X+XM8zsR5uhIDvvZpbS9aZQbCovg==} + cpu: [x64] + os: [netbsd] + + '@pnpm/exe.win32-arm64@12.21.0': + resolution: {integrity: sha512-7xTxxUXo/grRLivSeIl6B21gnsz7ooe5EMPcJmQqwxc8WLJVReN8MzrlHru8bqXfVr4X3+6ZGZscntKenlCBqQ==} + cpu: [arm64] + os: [win32] + + '@pnpm/exe.win32-x64@12.21.0': + resolution: {integrity: sha512-9TpkJemVApxJ1Z1w0ZFGN+AuSx4nJOqXSJUqMqDvaXTYwGOzvBiiWdFP9GN0ketiWCQS1Q0/pza2E7I3pP0OBQ==} + cpu: [x64] + os: [win32] + + pnpm@12.21.0: + resolution: {integrity: sha512-Zv2CeO4ok1zpUXktNDZ/869cQyonVkRYIwKVM4NbjaUpu+C+UTCv1W7QcT+4eJ5Hutgtk71a4v5UsVVi1idu8A==} + engines: {node: '>=18'} + hasBin: true + +snapshots: + + '@pnpm/exe.android-arm64@12.21.0': + optional: true + + '@pnpm/exe.android-x64@12.21.0': + optional: true + + '@pnpm/exe.darwin-arm64@12.21.0': + optional: true + + '@pnpm/exe.darwin-x64@12.21.0': + optional: true + + '@pnpm/exe.freebsd-x64@12.21.0': + optional: true + + '@pnpm/exe.linux-arm64-musl@12.21.0': + optional: true + + '@pnpm/exe.linux-arm64@12.21.0': + optional: true + + '@pnpm/exe.linux-ppc64@12.21.0': + optional: true + + '@pnpm/exe.linux-riscv64@12.21.0': + optional: true + + '@pnpm/exe.linux-s390x@12.21.0': + optional: true + + '@pnpm/exe.linux-x64-musl@12.21.0': + optional: true + + '@pnpm/exe.linux-x64@12.21.0': + optional: true + + '@pnpm/exe.netbsd-x64@12.21.0': + optional: true + + '@pnpm/exe.win32-arm64@12.21.0': + optional: true + + '@pnpm/exe.win32-x64@12.21.0': + optional: true + + pnpm@12.21.0: + optionalDependencies: + '@pnpm/exe.android-arm64': 12.21.0 + '@pnpm/exe.android-x64': 12.21.0 + '@pnpm/exe.darwin-arm64': 12.21.0 + '@pnpm/exe.darwin-x64': 12.21.0 + '@pnpm/exe.freebsd-x64': 12.21.0 + '@pnpm/exe.linux-arm64': 12.21.0 + '@pnpm/exe.linux-arm64-musl': 12.21.0 + '@pnpm/exe.linux-ppc64': 12.21.0 + '@pnpm/exe.linux-riscv64': 12.21.0 + '@pnpm/exe.linux-s390x': 12.21.0 + '@pnpm/exe.linux-x64': 12.21.0 + '@pnpm/exe.linux-x64-musl': 12.21.0 + '@pnpm/exe.netbsd-x64': 12.21.0 + '@pnpm/exe.win32-arm64': 12.21.0 + '@pnpm/exe.win32-x64': 12.21.0 + +--- lockfileVersion: '9.0' settings: diff --git a/tests/test_docs/test_mkdocs_build.py b/tests/test_docs/test_mkdocs_build.py deleted file mode 100644 index 467e15ef0..000000000 --- a/tests/test_docs/test_mkdocs_build.py +++ /dev/null @@ -1,48 +0,0 @@ -"""The documentation site must build with ``mkdocs build --strict``. - -Strict mode turns every warning into a failure: a ``:::`` reference to a name -that no longer exists, a broken link between pages, or a docstring whose -``Args:`` section names a parameter the function does not have. -""" - -from __future__ import annotations - -import subprocess -import sys -from pathlib import Path - -import pytest - -REPO_ROOT = Path(__file__).resolve().parents[2] - - -def test_mkdocs_build_strict(tmp_path: Path): - """The site builds with no warnings; skipped when the docs tools are absent.""" - pytest.importorskip("mkdocs", reason="mkdocs is in the 'dev' dependency group") - pytest.importorskip( - "mkdocstrings", reason="mkdocstrings is in the 'dev' dependency group" - ) - - proc = subprocess.run( - [ - sys.executable, - "-m", - "mkdocs", - "build", - "--strict", - "--site-dir", - str(tmp_path / "site"), - ], - cwd=REPO_ROOT, - capture_output=True, - text=True, - timeout=600, - check=False, - ) - output = proc.stdout + proc.stderr - problems = [ - line for line in output.splitlines() if "WARNING" in line or "ERROR" in line - ] - assert proc.returncode == 0, "mkdocs build --strict failed:\n" + "\n".join( - problems or output.splitlines()[-30:] - ) diff --git a/tests/test_docs/test_site_content.py b/tests/test_docs/test_site_content.py new file mode 100644 index 000000000..21d412e64 --- /dev/null +++ b/tests/test_docs/test_site_content.py @@ -0,0 +1,305 @@ +"""The documentation site's content build (``scripts/docs_site_content.py``). + +The Starlight site under ``site/`` is built from ``docs/`` by that script, which +converts every published page and generates the API reference from the source. It +fails on a broken link, a page that is neither published nor excluded, an object an API +page names that does not exist, or a docstring griffe reports a problem with; these +tests hold it to that, without Node. The site build itself (``pnpm build`` in +``site/``, which also validates every link and anchor) runs in the ``docs-site`` +workflow. + +Every test drives the script as a command, the way the site build runs it. +""" + +from __future__ import annotations + +import subprocess +import sys +from pathlib import Path + +import pytest + +REPO_ROOT = Path(__file__).resolve().parents[2] +SCRIPT = REPO_ROOT / "scripts" / "docs_site_content.py" + + +def run_build( + docs: Path, tmp_path: Path, base: str = "/" +) -> tuple[subprocess.CompletedProcess[str], Path, Path]: + out = tmp_path / "out" + public = tmp_path / "public" + proc = subprocess.run( + [ + sys.executable, + str(SCRIPT), + "--docs", + str(docs), + "--out", + str(out), + "--public", + str(public), + "--base", + base, + ], + capture_output=True, + text=True, + timeout=300, + check=False, + ) + return proc, out, public + + +def make_docs(tmp_path: Path, pages: dict[str, str]) -> Path: + docs = tmp_path / "docs" + for name in ("tutorial", "concepts", "reference", "api"): + (docs / name).mkdir(parents=True) + for path, text in pages.items(): + target = docs / path + target.parent.mkdir(parents=True, exist_ok=True) + _ = target.write_text(text, encoding="utf-8") + return docs + + +def build_ok(tmp_path: Path, pages: dict[str, str], base: str = "/") -> Path: + proc, out, _ = run_build(make_docs(tmp_path, pages), tmp_path, base) + assert proc.returncode == 0, proc.stderr + return out + + +def build_fails(tmp_path: Path, pages: dict[str, str]) -> str: + proc, _, _ = run_build(make_docs(tmp_path, pages), tmp_path) + assert proc.returncode != 0, "the build should have failed" + return proc.stderr + + +# --------------------------------------------------------------------------- +# The real documentation +# --------------------------------------------------------------------------- + + +def test_the_documentation_builds(tmp_path: Path): + """Every page converts, every link resolves, every API object and docstring renders.""" + proc, out, public = run_build(REPO_ROOT / "docs", tmp_path, "/orcapod-python/") + assert proc.returncode == 0, proc.stderr + assert (out / "index.md").is_file() + assert (out / "api" / "operators.md").is_file() + assert (public / "tutorial" / "workshop_data.py").is_file() + assert not (out / "dev").exists() + api = (out / "api" / "operators.md").read_text(encoding="utf-8") + assert '<a id="orcapod.core.operators.Join"></a>' in api + assert "\n::: " not in api + + +def test_the_build_is_deterministic(tmp_path: Path): + first, out_a, _ = run_build(REPO_ROOT / "docs", tmp_path / "a") + second, out_b, _ = run_build(REPO_ROOT / "docs", tmp_path / "b") + assert first.returncode == 0 and second.returncode == 0 + files_a = sorted(p.relative_to(out_a) for p in out_a.rglob("*.md")) + files_b = sorted(p.relative_to(out_b) for p in out_b.rglob("*.md")) + assert files_a == files_b + for rel in files_a: + assert (out_a / rel).read_bytes() == (out_b / rel).read_bytes(), rel + + +# --------------------------------------------------------------------------- +# Page conversion +# --------------------------------------------------------------------------- + + +def test_title_line_becomes_front_matter(tmp_path: Path): + out = build_ok(tmp_path, {"index.md": "# Identity & Hashing\n\nBody.\n"}) + assert (out / "index.md").read_text() == ( + '---\ntitle: "Identity & Hashing"\n---\n\nBody.\n' + ) + + +def test_a_page_without_a_title_fails(tmp_path: Path): + assert "title" in build_fails(tmp_path, {"index.md": "Body.\n"}) + + +def test_admonitions_become_asides(tmp_path: Path): + page = ( + "# P\n\n" + '!!! warning "Read `run()` first"\n' + " Text.\n" + "\n" + " ```python\n" + " x = 1\n" + " ```\n" + "\n" + "After.\n" + "\n" + "!!! tip\n" + " Short.\n" + ) + text = (build_ok(tmp_path, {"index.md": page}) / "index.md").read_text() + assert ":::caution[Read `run()` first]\nText.\n\n```python\nx = 1\n```\n:::" in text + assert ":::tip\nShort.\n:::" in text + assert "\nAfter.\n" in text + + +def test_nested_admonition_gets_a_longer_fence(tmp_path: Path): + page = '# P\n\n!!! note "Outer"\n !!! tip\n Inner.\n' + text = (build_ok(tmp_path, {"index.md": page}) / "index.md").read_text() + assert "::::note[Outer]\n:::tip\nInner.\n:::\n::::" in text + + +def test_collapsible_admonition_becomes_details(tmp_path: Path): + page = '# P\n\n??? success "Solution"\n Answer.\n' + text = (build_ok(tmp_path, {"index.md": page}) / "index.md").read_text() + assert "<details>\n<summary>Solution</summary>\n\nAnswer.\n\n</details>" in text + + +def test_admonition_syntax_inside_a_code_block_is_kept(tmp_path: Path): + page = '# P\n\n```text\n!!! note "x"\n y\n```\n' + text = (build_ok(tmp_path, {"index.md": page}) / "index.md").read_text() + assert '```text\n!!! note "x"\n y\n```' in text + + +def test_unknown_admonition_type_fails(tmp_path: Path): + page = "# P\n\n!!! abstract\n x\n" + assert "abstract" in build_fails(tmp_path, {"index.md": page}) + + +def test_skip_markers_and_the_header_comment_are_removed(tmp_path: Path): + page = ( + "# P\n<!--\nNote to authors.\n-->\n\n" + "<!-- docs-test: skip -->\n```python\nx = 1\n```\n" + ) + text = (build_ok(tmp_path, {"index.md": page}) / "index.md").read_text() + assert "<!--" not in text + assert "```python\nx = 1\n```" in text + + +# --------------------------------------------------------------------------- +# Links +# --------------------------------------------------------------------------- + + +def test_page_links_become_site_urls_with_the_base(tmp_path: Path): + pages = { + "index.md": "# Home\n\nSee [s](concepts/sources.md) and [t](tutorial/index.md).\n", + "concepts/sources.md": "# Sources\n\nBack to [home](../index.md#top).\n", + "tutorial/index.md": "# Tutorial\n\nText.\n", + } + out = build_ok(tmp_path, pages, base="/orcapod-python/") + home = (out / "index.md").read_text() + assert "[s](/orcapod-python/concepts/sources/)" in home + assert "[t](/orcapod-python/tutorial/)" in home + sources = (out / "concepts" / "sources.md").read_text() + assert "[home](/orcapod-python/#top)" in sources + + +def test_mkdocs_anchors_become_starlight_anchors(tmp_path: Path): + pages = { + "index.md": ( + "# Home\n\n" + "[a](concepts/function-pods.md#pipelinejob-database-backed-cached-execution)" + " [b](#same-page-twice_1)\n\n" + "## Same page twice\n\n## Same page twice\n" + ), + "concepts/function-pods.md": ( + "# FP\n\n## `PipelineJob` -- database-backed, cached execution\n" + ), + } + home = (build_ok(tmp_path, pages) / "index.md").read_text() + assert ( + "/concepts/function-pods/#pipelinejob----database-backed-cached-execution" + in (home) + ) + assert "[b](#same-page-twice-1)" in home + + +def test_links_in_code_are_not_rewritten(tmp_path: Path): + page = "# P\n\n`[x](nope.md)`\n\n```markdown\n[y](nope.md)\n```\n" + text = (build_ok(tmp_path, {"index.md": page}) / "index.md").read_text() + assert "`[x](nope.md)`" in text + assert "[y](nope.md)" in text + + +def test_external_links_are_kept(tmp_path: Path): + page = "# P\n\n[x](https://example.org/a.md) [m](mailto:a@b.c)\n" + text = (build_ok(tmp_path, {"index.md": page}) / "index.md").read_text() + assert "[x](https://example.org/a.md) [m](mailto:a@b.c)" in text + + +def test_linked_file_is_copied(tmp_path: Path): + pages = { + "tutorial/index.md": "# T\n\nDownload [`data.py`](data.py).\n", + "tutorial/data.py": "print('hi')\n", + } + docs = make_docs(tmp_path, pages) + proc, out, public = run_build(docs, tmp_path, "/b/") + assert proc.returncode == 0, proc.stderr + assert ( + "[`data.py`](/b/tutorial/data.py)" + in (out / "tutorial" / "index.md").read_text() + ) + assert (public / "tutorial" / "data.py").read_text() == "print('hi')\n" + + +@pytest.mark.parametrize( + ("link", "message"), + [ + ("missing.md", "is not a published page"), + ("../dev/notes.md", "is not a published page"), + ("missing.py", "does not exist"), + ("../../outside.md", "leaves docs/"), + ], +) +def test_a_broken_link_fails(tmp_path: Path, link: str, message: str): + pages = {"concepts/a.md": f"# A\n\n[x]({link})\n", "dev/notes.md": "# Notes\n"} + stderr = build_fails(tmp_path, pages) + assert "docs/concepts/a.md" in stderr + assert message in stderr + + +# --------------------------------------------------------------------------- +# What is published +# --------------------------------------------------------------------------- + + +def test_excluded_folders_are_not_published(tmp_path: Path): + out = build_ok(tmp_path, {"index.md": "# H\n", "dev/plan.md": "# Plan\n"}) + assert not (out / "dev").exists() + + +def test_an_unknown_top_level_entry_fails(tmp_path: Path): + stderr = build_fails(tmp_path, {"index.md": "# H\n", "guides/a.md": "# A\n"}) + assert "guides" in stderr + + +def test_a_folder_inside_a_published_folder_fails(tmp_path: Path): + stderr = build_fails(tmp_path, {"concepts/more/a.md": "# A\n"}) + assert "concepts/more" in stderr + + +# --------------------------------------------------------------------------- +# API pages +# --------------------------------------------------------------------------- + + +def test_api_page_is_generated_from_the_source(tmp_path: Path): + pages = {"api/types.md": "# Types\n\nIntro.\n\n::: orcapod.types.Schema\n"} + text = (build_ok(tmp_path, pages) / "api" / "types.md").read_text() + assert '<a id="orcapod.types.Schema"></a>\n\n## `Schema`' in text + assert '<a id="orcapod.types.Schema.merge"></a>' in text + assert "**Raises:**" in text + assert "Intro." in text + + +def test_api_page_naming_a_missing_object_fails(tmp_path: Path): + pages = {"api/types.md": "# Types\n\n::: orcapod.types.NoSuchThing\n"} + assert "orcapod.types.NoSuchThing" in build_fails(tmp_path, pages) + + +def test_a_removed_page_leaves_the_site(tmp_path: Path): + docs = make_docs(tmp_path, {"index.md": "# H\n", "concepts/a.md": "# A\n"}) + proc, out, _ = run_build(docs, tmp_path) + assert proc.returncode == 0, proc.stderr + assert (out / "concepts" / "a.md").is_file() + (docs / "concepts" / "a.md").unlink() + proc, out, _ = run_build(docs, tmp_path) + assert proc.returncode == 0, proc.stderr + assert not (out / "concepts").exists() + assert (out / "index.md").is_file() diff --git a/uv.lock b/uv.lock index fa31d7802..748e1277b 100644 --- a/uv.lock +++ b/uv.lock @@ -271,29 +271,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/77/06/bb80f5f86020c4551da315d78b3ab75e8228f89f0162f2c3a819e407941a/attrs-25.3.0-py3-none-any.whl", hash = "sha256:427318ce031701fea540783410126f03899a97ffc6f61596ad581ac2e40e3bc3", size = 63815, upload-time = "2025-03-13T11:10:21.14Z" }, ] -[[package]] -name = "babel" -version = "2.17.0" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/7d/6b/d52e42361e1aa00709585ecc30b3f9684b3ab62530771402248b1b1d6240/babel-2.17.0.tar.gz", hash = "sha256:0c54cffb19f690cdcc52a3b50bcbf71e07a808d1c80d549f2459b9d2cf0afb9d", size = 9951852, upload-time = "2025-02-01T15:17:41.026Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/b7/b8/3fe70c75fe32afc4bb507f75563d39bc5642255d1d94f1f23604725780bf/babel-2.17.0-py3-none-any.whl", hash = "sha256:4d0b53093fdfb4b21c92b5213dba5a1b23885afa8383709427046b21c366e5f2", size = 10182537, upload-time = "2025-02-01T15:17:37.39Z" }, -] - -[[package]] -name = "backrefs" -version = "6.2" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/4e/a6/e325ec73b638d3ede4421b5445d4a0b8b219481826cc079d510100af356c/backrefs-6.2.tar.gz", hash = "sha256:f44ff4d48808b243b6c0cdc6231e22195c32f77046018141556c66f8bab72a49", size = 7012303, upload-time = "2026-02-16T19:10:15.828Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/1b/39/3765df263e08a4df37f4f43cb5aa3c6c17a4bdd42ecfe841e04c26037171/backrefs-6.2-py310-none-any.whl", hash = "sha256:0fdc7b012420b6b144410342caeb8adc54c6866cf12064abc9bb211302e496f8", size = 381075, upload-time = "2026-02-16T19:10:04.322Z" }, - { url = "https://files.pythonhosted.org/packages/0f/f0/35240571e1b67ffb19dafb29ab34150b6f59f93f717b041082cdb1bfceb1/backrefs-6.2-py311-none-any.whl", hash = "sha256:08aa7fae530c6b2361d7bdcbda1a7c454e330cc9dbcd03f5c23205e430e5c3be", size = 392874, upload-time = "2026-02-16T19:10:06.314Z" }, - { url = "https://files.pythonhosted.org/packages/e3/63/77e8c9745b4d227cce9f5e0a6f68041278c5f9b18588b35905f5f19c1beb/backrefs-6.2-py312-none-any.whl", hash = "sha256:c3f4b9cb2af8cda0d87ab4f57800b57b95428488477be164dd2b47be54db0c90", size = 398787, upload-time = "2026-02-16T19:10:08.274Z" }, - { url = "https://files.pythonhosted.org/packages/c5/71/c754b1737ad99102e03fa3235acb6cb6d3ac9d6f596cbc3e5f236705abd8/backrefs-6.2-py313-none-any.whl", hash = "sha256:12df81596ab511f783b7d87c043ce26bc5b0288cf3bb03610fe76b8189282b2b", size = 400747, upload-time = "2026-02-16T19:10:09.791Z" }, - { url = "https://files.pythonhosted.org/packages/af/75/be12ba31a6eb20dccef2320cd8ccb3f7d9013b68ba4c70156259fee9e409/backrefs-6.2-py314-none-any.whl", hash = "sha256:e5f805ae09819caa1aa0623b4a83790e7028604aa2b8c73ba602c4454e665de7", size = 412602, upload-time = "2026-02-16T19:10:12.317Z" }, - { url = "https://files.pythonhosted.org/packages/21/f8/d02f650c47d05034dcd6f9c8cf94f39598b7a89c00ecda0ecb2911bc27e9/backrefs-6.2-py39-none-any.whl", hash = "sha256:664e33cd88c6840b7625b826ecf2555f32d491800900f5a541f772c485f7cda7", size = 381077, upload-time = "2026-02-16T19:10:13.74Z" }, -] - [[package]] name = "basedpyright" version = "1.38.4" @@ -1017,18 +994,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/d5/1f/5f4a3cd9e4440e9d9bc78ad0a91a1c8d46b4d429d5239ebe6793c9fe5c41/fsspec-2026.3.0-py3-none-any.whl", hash = "sha256:d2ceafaad1b3457968ed14efa28798162f1638dbb5d2a6868a2db002a5ee39a4", size = 202595, upload-time = "2026-03-27T19:11:13.595Z" }, ] -[[package]] -name = "ghp-import" -version = "2.1.0" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "python-dateutil" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/d9/29/d40217cbe2f6b1359e00c6c307bb3fc876ba74068cbab3dde77f03ca0dc4/ghp-import-2.1.0.tar.gz", hash = "sha256:9c535c4c61193c2df8871222567d7fd7e5014d835f97dc7b7439069e2413d343", size = 10943, upload-time = "2022-05-02T15:47:16.11Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/f7/ec/67fbef5d497f86283db54c22eec6f6140243aae73265799baaaa19cd17fb/ghp_import-2.1.0-py3-none-any.whl", hash = "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619", size = 11034, upload-time = "2022-05-02T15:47:14.552Z" }, -] - [[package]] name = "gitdb" version = "4.0.12" @@ -1631,15 +1596,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/4c/fa/be89a49c640930180657482a74970cdcf6f7072c8d2471e1babe17a222dc/kiwisolver-1.4.8-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:be4816dc51c8a471749d664161b434912eee82f2ea66bd7628bd14583a833e85", size = 2349213, upload-time = "2024-12-24T18:30:40.019Z" }, ] -[[package]] -name = "markdown" -version = "3.10.2" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/2b/f4/69fa6ed85ae003c2378ffa8f6d2e3234662abd02c10d216c0ba96081a238/markdown-3.10.2.tar.gz", hash = "sha256:994d51325d25ad8aa7ce4ebaec003febcce822c3f8c911e3b17c52f7f589f950", size = 368805, upload-time = "2026-02-09T14:57:26.942Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/de/1f/77fa3081e4f66ca3576c896ae5d31c3002ac6607f9747d2e3aa49227e464/markdown-3.10.2-py3-none-any.whl", hash = "sha256:e91464b71ae3ee7afd3017d9f358ef0baf158fd9a298db92f1d4761133824c36", size = 108180, upload-time = "2026-02-09T14:57:25.787Z" }, -] - [[package]] name = "markdown-it-py" version = "3.0.0" @@ -1764,134 +1720,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/b3/38/89ba8ad64ae25be8de66a6d463314cf1eb366222074cfda9ee839c56a4b4/mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", size = 9979, upload-time = "2022-08-14T12:40:09.779Z" }, ] -[[package]] -name = "mergedeep" -version = "1.3.4" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/3a/41/580bb4006e3ed0361b8151a01d324fb03f420815446c7def45d02f74c270/mergedeep-1.3.4.tar.gz", hash = "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8", size = 4661, upload-time = "2021-02-05T18:55:30.623Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/2c/19/04f9b178c2d8a15b076c8b5140708fa6ffc5601fb6f1e975537072df5b2a/mergedeep-1.3.4-py3-none-any.whl", hash = "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307", size = 6354, upload-time = "2021-02-05T18:55:29.583Z" }, -] - -[[package]] -name = "mkdocs" -version = "1.6.1" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "click" }, - { name = "colorama", marker = "sys_platform == 'win32'" }, - { name = "ghp-import" }, - { name = "jinja2" }, - { name = "markdown" }, - { name = "markupsafe" }, - { name = "mergedeep" }, - { name = "mkdocs-get-deps" }, - { name = "packaging" }, - { name = "pathspec" }, - { name = "pyyaml" }, - { name = "pyyaml-env-tag" }, - { name = "watchdog" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/bc/c6/bbd4f061bd16b378247f12953ffcb04786a618ce5e904b8c5a01a0309061/mkdocs-1.6.1.tar.gz", hash = "sha256:7b432f01d928c084353ab39c57282f29f92136665bdd6abf7c1ec8d822ef86f2", size = 3889159, upload-time = "2024-08-30T12:24:06.899Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/22/5b/dbc6a8cddc9cfa9c4971d59fb12bb8d42e161b7e7f8cc89e49137c5b279c/mkdocs-1.6.1-py3-none-any.whl", hash = "sha256:db91759624d1647f3f34aa0c3f327dd2601beae39a366d6e064c03468d35c20e", size = 3864451, upload-time = "2024-08-30T12:24:05.054Z" }, -] - -[[package]] -name = "mkdocs-autorefs" -version = "1.4.4" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "markdown" }, - { name = "markupsafe" }, - { name = "mkdocs" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/52/c0/f641843de3f612a6b48253f39244165acff36657a91cc903633d456ae1ac/mkdocs_autorefs-1.4.4.tar.gz", hash = "sha256:d54a284f27a7346b9c38f1f852177940c222da508e66edc816a0fa55fc6da197", size = 56588, upload-time = "2026-02-10T15:23:55.105Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/28/de/a3e710469772c6a89595fc52816da05c1e164b4c866a89e3cb82fb1b67c5/mkdocs_autorefs-1.4.4-py3-none-any.whl", hash = "sha256:834ef5408d827071ad1bc69e0f39704fa34c7fc05bc8e1c72b227dfdc5c76089", size = 25530, upload-time = "2026-02-10T15:23:53.817Z" }, -] - -[[package]] -name = "mkdocs-get-deps" -version = "0.2.2" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "mergedeep" }, - { name = "platformdirs" }, - { name = "pyyaml" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/ce/25/b3cccb187655b9393572bde9b09261d267c3bf2f2cdabe347673be5976a6/mkdocs_get_deps-0.2.2.tar.gz", hash = "sha256:8ee8d5f316cdbbb2834bc1df6e69c08fe769a83e040060de26d3c19fad3599a1", size = 11047, upload-time = "2026-03-10T02:46:33.632Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/88/29/744136411e785c4b0b744d5413e56555265939ab3a104c6a4b719dad33fd/mkdocs_get_deps-0.2.2-py3-none-any.whl", hash = "sha256:e7878cbeac04860b8b5e0ca31d3abad3df9411a75a32cde82f8e44b6c16ff650", size = 9555, upload-time = "2026-03-10T02:46:32.256Z" }, -] - -[[package]] -name = "mkdocs-material" -version = "9.7.6" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "babel" }, - { name = "backrefs" }, - { name = "colorama" }, - { name = "jinja2" }, - { name = "markdown" }, - { name = "mkdocs" }, - { name = "mkdocs-material-extensions" }, - { name = "paginate" }, - { name = "pygments" }, - { name = "pymdown-extensions" }, - { name = "requests" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/45/29/6d2bcf41ae40802c4beda2432396fff97b8456fb496371d1bc7aad6512ec/mkdocs_material-9.7.6.tar.gz", hash = "sha256:00bdde50574f776d328b1862fe65daeaf581ec309bd150f7bff345a098c64a69", size = 4097959, upload-time = "2026-03-19T15:41:58.161Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/2c/01/bc663630c510822c95c47a66af9fa7a443c295b47d5f041e5e6ae62ef659/mkdocs_material-9.7.6-py3-none-any.whl", hash = "sha256:71b84353921b8ea1ba84fe11c50912cc512da8fe0881038fcc9a0761c0e635ba", size = 9305470, upload-time = "2026-03-19T15:41:55.217Z" }, -] - -[[package]] -name = "mkdocs-material-extensions" -version = "1.3.1" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/79/9b/9b4c96d6593b2a541e1cb8b34899a6d021d208bb357042823d4d2cabdbe7/mkdocs_material_extensions-1.3.1.tar.gz", hash = "sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443", size = 11847, upload-time = "2023-11-22T19:09:45.208Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/5b/54/662a4743aa81d9582ee9339d4ffa3c8fd40a4965e033d77b9da9774d3960/mkdocs_material_extensions-1.3.1-py3-none-any.whl", hash = "sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31", size = 8728, upload-time = "2023-11-22T19:09:43.465Z" }, -] - -[[package]] -name = "mkdocstrings" -version = "1.0.3" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "jinja2" }, - { name = "markdown" }, - { name = "markupsafe" }, - { name = "mkdocs" }, - { name = "mkdocs-autorefs" }, - { name = "pymdown-extensions" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/46/62/0dfc5719514115bf1781f44b1d7f2a0923fcc01e9c5d7990e48a05c9ae5d/mkdocstrings-1.0.3.tar.gz", hash = "sha256:ab670f55040722b49bb45865b2e93b824450fb4aef638b00d7acb493a9020434", size = 100946, upload-time = "2026-02-07T14:31:40.973Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/04/41/1cf02e3df279d2dd846a1bf235a928254eba9006dd22b4a14caa71aed0f7/mkdocstrings-1.0.3-py3-none-any.whl", hash = "sha256:0d66d18430c2201dc7fe85134277382baaa15e6b30979f3f3bdbabd6dbdb6046", size = 35523, upload-time = "2026-02-07T14:31:39.27Z" }, -] - -[package.optional-dependencies] -python = [ - { name = "mkdocstrings-python" }, -] - -[[package]] -name = "mkdocstrings-python" -version = "2.0.3" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "griffelib" }, - { name = "mkdocs-autorefs" }, - { name = "mkdocstrings" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/29/33/c225eaf898634bdda489a6766fc35d1683c640bffe0e0acd10646b13536d/mkdocstrings_python-2.0.3.tar.gz", hash = "sha256:c518632751cc869439b31c9d3177678ad2bfa5c21b79b863956ad68fc92c13b8", size = 199083, upload-time = "2026-02-20T10:38:36.368Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/32/28/79f0f8de97cce916d5ae88a7bee1ad724855e83e6019c0b4d5b3fabc80f3/mkdocstrings_python-2.0.3-py3-none-any.whl", hash = "sha256:0b83513478bdfd803ff05aa43e9b1fca9dd22bcd9471f09ca6257f009bc5ee12", size = 104779, upload-time = "2026-02-20T10:38:34.517Z" }, -] - [[package]] name = "mmh3" version = "5.1.0" @@ -2346,6 +2174,7 @@ dev = [ { name = "basedpyright" }, { name = "flask" }, { name = "flask-cors" }, + { name = "griffelib" }, { name = "httpie" }, { name = "hydra-core" }, { name = "hypothesis" }, @@ -2353,8 +2182,6 @@ dev = [ { name = "ipykernel" }, { name = "ipywidgets" }, { name = "jsonschema" }, - { name = "mkdocs-material" }, - { name = "mkdocstrings", extra = ["python"] }, { name = "moto", extra = ["s3"] }, { name = "orcapod", extra = ["torch"] }, { name = "pip-licenses" }, @@ -2417,6 +2244,7 @@ dev = [ { name = "basedpyright", specifier = ">=1.38.1" }, { name = "flask", specifier = ">=3.0" }, { name = "flask-cors", specifier = ">=5.0" }, + { name = "griffelib", specifier = ">=2.0.2" }, { name = "httpie", specifier = ">=3.2.4" }, { name = "hydra-core", specifier = ">=1.3.2" }, { name = "hypothesis", specifier = ">=6.0" }, @@ -2424,8 +2252,6 @@ dev = [ { name = "ipykernel", specifier = ">=6.29.5" }, { name = "ipywidgets", specifier = ">=8.1.7" }, { name = "jsonschema", specifier = ">=4.25.0" }, - { name = "mkdocs-material", specifier = ">=9.7.5" }, - { name = "mkdocstrings", extras = ["python"], specifier = ">=1.0.3" }, { name = "moto", extras = ["s3"], specifier = ">=5.1" }, { name = "orcapod", extras = ["torch"] }, { name = "pip-licenses", specifier = ">=5.0.0" }, @@ -2523,15 +2349,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/20/12/38679034af332785aac8774540895e234f4d07f7545804097de4b666afd8/packaging-25.0-py3-none-any.whl", hash = "sha256:29572ef2b1f17581046b3a2227d5c611fb25ec70ca1ba8554b24b0e69331a484", size = 66469, upload-time = "2025-04-19T11:48:57.875Z" }, ] -[[package]] -name = "paginate" -version = "0.5.7" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/ec/46/68dde5b6bc00c1296ec6466ab27dddede6aec9af1b99090e1107091b3b84/paginate-0.5.7.tar.gz", hash = "sha256:22bd083ab41e1a8b4f3690544afb2c60c25e5c9a63a30fa2f483f6c60c8e5945", size = 19252, upload-time = "2024-08-25T14:17:24.139Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/90/96/04b8e52da071d28f5e21a805b19cb9390aa17a47462ac87f5e2696b9566d/paginate-0.5.7-py2.py3-none-any.whl", hash = "sha256:b885e2af73abcf01d9559fd5216b57ef722f8c42affbb63942377668e35c7591", size = 13746, upload-time = "2024-08-25T14:17:22.55Z" }, -] - [[package]] name = "pandas" version = "2.2.3" @@ -2591,15 +2408,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/b1/29/c028a0731e202035f0e2e0bfbf1a3e46ad6c628cbb17f6f1cc9eea5d9ff1/pathlib_abc-0.5.2-py3-none-any.whl", hash = "sha256:4c9d94cf1b23af417ce7c0417b43333b06a106c01000b286c99de230d95eefbb", size = 19070, upload-time = "2025-10-10T18:37:19.437Z" }, ] -[[package]] -name = "pathspec" -version = "1.0.4" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/fa/36/e27608899f9b8d4dff0617b2d9ab17ca5608956ca44461ac14ac48b44015/pathspec-1.0.4.tar.gz", hash = "sha256:0210e2ae8a21a9137c0d470578cb0e595af87edaa6ebf12ff176f14a02e0e645", size = 131200, upload-time = "2026-01-27T03:59:46.938Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/ef/3c/2c197d226f9ea224a9ab8d197933f9da0ae0aac5b6e0f884e2b8d9c8e9f7/pathspec-1.0.4-py3-none-any.whl", hash = "sha256:fb6ae2fd4e7c921a165808a552060e722767cfa526f99ca5156ed2ce45a5c723", size = 55206, upload-time = "2026-01-27T03:59:45.137Z" }, -] - [[package]] name = "pexpect" version = "4.9.0" @@ -3292,19 +3100,6 @@ crypto = [ { name = "cryptography" }, ] -[[package]] -name = "pymdown-extensions" -version = "10.21.2" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "markdown" }, - { name = "pyyaml" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/df/08/f1c908c581fd11913da4711ea7ba32c0eee40b0190000996bb863b0c9349/pymdown_extensions-10.21.2.tar.gz", hash = "sha256:c3f55a5b8a1d0edf6699e35dcbea71d978d34ff3fa79f3d807b8a5b3fa90fbdc", size = 853922, upload-time = "2026-03-29T15:01:55.233Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/f7/27/a2fc51a4a122dfd1015e921ae9d22fee3d20b0b8080d9a704578bf9deece/pymdown_extensions-10.21.2-py3-none-any.whl", hash = "sha256:5c0fd2a2bea14eb39af8ff284f1066d898ab2187d81b889b75d46d4348c01638", size = 268901, upload-time = "2026-03-29T15:01:53.244Z" }, -] - [[package]] name = "pyparsing" version = "3.2.3" @@ -3493,18 +3288,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/fa/de/02b54f42487e3d3c6efb3f89428677074ca7bf43aae402517bc7cca949f3/PyYAML-6.0.2-cp313-cp313-win_amd64.whl", hash = "sha256:8388ee1976c416731879ac16da0aff3f63b286ffdd57cdeb95f3f2e085687563", size = 156446, upload-time = "2024-08-06T20:33:04.33Z" }, ] -[[package]] -name = "pyyaml-env-tag" -version = "1.1" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "pyyaml" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/eb/2e/79c822141bfd05a853236b504869ebc6b70159afc570e1d5a20641782eaa/pyyaml_env_tag-1.1.tar.gz", hash = "sha256:2eb38b75a2d21ee0475d6d97ec19c63287a7e140231e4214969d0eac923cd7ff", size = 5737, upload-time = "2025-05-13T15:24:01.64Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/04/11/432f32f8097b03e3cd5fe57e88efb685d964e2e5178a48ed61e841f7fdce/pyyaml_env_tag-1.1-py3-none-any.whl", hash = "sha256:17109e1a528561e32f026364712fee1264bc2ea6715120891174ed1b980d2e04", size = 4722, upload-time = "2025-05-13T15:23:59.629Z" }, -] - [[package]] name = "pyzmq" version = "26.4.0" @@ -4322,33 +4105,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/43/87/b22cf40cdf7e2b2bf83f38a94d2c90c5ad6c304896e5a12d0c08a602eb59/virtualenv-20.33.0-py3-none-any.whl", hash = "sha256:106b6baa8ab1b526d5a9b71165c85c456fbd49b16976c88e2bc9352ee3bc5d3f", size = 6060205, upload-time = "2025-08-03T08:09:16.674Z" }, ] -[[package]] -name = "watchdog" -version = "6.0.0" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/db/7d/7f3d619e951c88ed75c6037b246ddcf2d322812ee8ea189be89511721d54/watchdog-6.0.0.tar.gz", hash = "sha256:9ddf7c82fda3ae8e24decda1338ede66e1c99883db93711d8fb941eaa2d8c282", size = 131220, upload-time = "2024-11-01T14:07:13.037Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/e0/24/d9be5cd6642a6aa68352ded4b4b10fb0d7889cb7f45814fb92cecd35f101/watchdog-6.0.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:6eb11feb5a0d452ee41f824e271ca311a09e250441c262ca2fd7ebcf2461a06c", size = 96393, upload-time = "2024-11-01T14:06:31.756Z" }, - { url = "https://files.pythonhosted.org/packages/63/7a/6013b0d8dbc56adca7fdd4f0beed381c59f6752341b12fa0886fa7afc78b/watchdog-6.0.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:ef810fbf7b781a5a593894e4f439773830bdecb885e6880d957d5b9382a960d2", size = 88392, upload-time = "2024-11-01T14:06:32.99Z" }, - { url = "https://files.pythonhosted.org/packages/d1/40/b75381494851556de56281e053700e46bff5b37bf4c7267e858640af5a7f/watchdog-6.0.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:afd0fe1b2270917c5e23c2a65ce50c2a4abb63daafb0d419fde368e272a76b7c", size = 89019, upload-time = "2024-11-01T14:06:34.963Z" }, - { url = "https://files.pythonhosted.org/packages/39/ea/3930d07dafc9e286ed356a679aa02d777c06e9bfd1164fa7c19c288a5483/watchdog-6.0.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:bdd4e6f14b8b18c334febb9c4425a878a2ac20efd1e0b231978e7b150f92a948", size = 96471, upload-time = "2024-11-01T14:06:37.745Z" }, - { url = "https://files.pythonhosted.org/packages/12/87/48361531f70b1f87928b045df868a9fd4e253d9ae087fa4cf3f7113be363/watchdog-6.0.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:c7c15dda13c4eb00d6fb6fc508b3c0ed88b9d5d374056b239c4ad1611125c860", size = 88449, upload-time = "2024-11-01T14:06:39.748Z" }, - { url = "https://files.pythonhosted.org/packages/5b/7e/8f322f5e600812e6f9a31b75d242631068ca8f4ef0582dd3ae6e72daecc8/watchdog-6.0.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:6f10cb2d5902447c7d0da897e2c6768bca89174d0c6e1e30abec5421af97a5b0", size = 89054, upload-time = "2024-11-01T14:06:41.009Z" }, - { url = "https://files.pythonhosted.org/packages/68/98/b0345cabdce2041a01293ba483333582891a3bd5769b08eceb0d406056ef/watchdog-6.0.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:490ab2ef84f11129844c23fb14ecf30ef3d8a6abafd3754a6f75ca1e6654136c", size = 96480, upload-time = "2024-11-01T14:06:42.952Z" }, - { url = "https://files.pythonhosted.org/packages/85/83/cdf13902c626b28eedef7ec4f10745c52aad8a8fe7eb04ed7b1f111ca20e/watchdog-6.0.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:76aae96b00ae814b181bb25b1b98076d5fc84e8a53cd8885a318b42b6d3a5134", size = 88451, upload-time = "2024-11-01T14:06:45.084Z" }, - { url = "https://files.pythonhosted.org/packages/fe/c4/225c87bae08c8b9ec99030cd48ae9c4eca050a59bf5c2255853e18c87b50/watchdog-6.0.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:a175f755fc2279e0b7312c0035d52e27211a5bc39719dd529625b1930917345b", size = 89057, upload-time = "2024-11-01T14:06:47.324Z" }, - { url = "https://files.pythonhosted.org/packages/a9/c7/ca4bf3e518cb57a686b2feb4f55a1892fd9a3dd13f470fca14e00f80ea36/watchdog-6.0.0-py3-none-manylinux2014_aarch64.whl", hash = "sha256:7607498efa04a3542ae3e05e64da8202e58159aa1fa4acddf7678d34a35d4f13", size = 79079, upload-time = "2024-11-01T14:06:59.472Z" }, - { url = "https://files.pythonhosted.org/packages/5c/51/d46dc9332f9a647593c947b4b88e2381c8dfc0942d15b8edc0310fa4abb1/watchdog-6.0.0-py3-none-manylinux2014_armv7l.whl", hash = "sha256:9041567ee8953024c83343288ccc458fd0a2d811d6a0fd68c4c22609e3490379", size = 79078, upload-time = "2024-11-01T14:07:01.431Z" }, - { url = "https://files.pythonhosted.org/packages/d4/57/04edbf5e169cd318d5f07b4766fee38e825d64b6913ca157ca32d1a42267/watchdog-6.0.0-py3-none-manylinux2014_i686.whl", hash = "sha256:82dc3e3143c7e38ec49d61af98d6558288c415eac98486a5c581726e0737c00e", size = 79076, upload-time = "2024-11-01T14:07:02.568Z" }, - { url = "https://files.pythonhosted.org/packages/ab/cc/da8422b300e13cb187d2203f20b9253e91058aaf7db65b74142013478e66/watchdog-6.0.0-py3-none-manylinux2014_ppc64.whl", hash = "sha256:212ac9b8bf1161dc91bd09c048048a95ca3a4c4f5e5d4a7d1b1a7d5752a7f96f", size = 79077, upload-time = "2024-11-01T14:07:03.893Z" }, - { url = "https://files.pythonhosted.org/packages/2c/3b/b8964e04ae1a025c44ba8e4291f86e97fac443bca31de8bd98d3263d2fcf/watchdog-6.0.0-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:e3df4cbb9a450c6d49318f6d14f4bbc80d763fa587ba46ec86f99f9e6876bb26", size = 79078, upload-time = "2024-11-01T14:07:05.189Z" }, - { url = "https://files.pythonhosted.org/packages/62/ae/a696eb424bedff7407801c257d4b1afda455fe40821a2be430e173660e81/watchdog-6.0.0-py3-none-manylinux2014_s390x.whl", hash = "sha256:2cce7cfc2008eb51feb6aab51251fd79b85d9894e98ba847408f662b3395ca3c", size = 79077, upload-time = "2024-11-01T14:07:06.376Z" }, - { url = "https://files.pythonhosted.org/packages/b5/e8/dbf020b4d98251a9860752a094d09a65e1b436ad181faf929983f697048f/watchdog-6.0.0-py3-none-manylinux2014_x86_64.whl", hash = "sha256:20ffe5b202af80ab4266dcd3e91aae72bf2da48c0d33bdb15c66658e685e94e2", size = 79078, upload-time = "2024-11-01T14:07:07.547Z" }, - { url = "https://files.pythonhosted.org/packages/07/f6/d0e5b343768e8bcb4cda79f0f2f55051bf26177ecd5651f84c07567461cf/watchdog-6.0.0-py3-none-win32.whl", hash = "sha256:07df1fdd701c5d4c8e55ef6cf55b8f0120fe1aef7ef39a1c6fc6bc2e606d517a", size = 79065, upload-time = "2024-11-01T14:07:09.525Z" }, - { url = "https://files.pythonhosted.org/packages/db/d9/c495884c6e548fce18a8f40568ff120bc3a4b7b99813081c8ac0c936fa64/watchdog-6.0.0-py3-none-win_amd64.whl", hash = "sha256:cbafb470cf848d93b5d013e2ecb245d4aa1c8fd0504e863ccefa32445359d680", size = 79070, upload-time = "2024-11-01T14:07:10.686Z" }, - { url = "https://files.pythonhosted.org/packages/33/e8/e40370e6d74ddba47f002a32919d91310d6074130fe4e17dabcafc15cbf1/watchdog-6.0.0-py3-none-win_ia64.whl", hash = "sha256:a1914259fa9e1454315171103c6a30961236f508b9b623eae470268bbcc6a22f", size = 79067, upload-time = "2024-11-01T14:07:11.845Z" }, -] - [[package]] name = "wcwidth" version = "0.2.13" From 76cf3cabcb318776852a618fadba79642c8ebc45 Mon Sep 17 00:00:00 2001 From: "Edgar Y. Walker" <> Date: Mon, 16 Nov 2026 16:35:58 -0800 Subject: [PATCH 03/10] docs(readme): the documentation is built as a site, not with mkdocs (ITL-1170) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 046592701..402b706ce 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ Orcapod's Python library for developing reproducible scientific pipelines. User documentation lives in [`docs/`](docs/index.md) (start with -[Getting Started](docs/getting-started.md)) and is built with `uv run mkdocs build --strict`. +[Getting Started](docs/getting-started.md)) and is published as a website built from it +(see [`site/README.md`](site/README.md)). `tests/test_docs/` executes the Python samples in this README, `docs/index.md`, `docs/getting-started.md`, `docs/concepts/` and `docs/reference/`, except the two samples in `docs/concepts/file-hash-caching.md` that need a PostgreSQL server. From 6e700e607fea4d441a16558f56d02e0090b1b9b3 Mon Sep 17 00:00:00 2001 From: "Edgar Y. Walker" <> Date: Mon, 16 Nov 2026 16:47:13 -0800 Subject: [PATCH 04/10] docs(site): say what to do when a preview server is already running (ITL-1170) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --- site/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/site/README.md b/site/README.md index d5541e84c..612ed037e 100644 --- a/site/README.md +++ b/site/README.md @@ -21,6 +21,11 @@ pnpm dev # live preview while editing docs/ or the sourc excluded, an object an API page names that does not exist, or a docstring problem. Search works in `pnpm preview`, not in `pnpm dev`. +Only one preview server runs per project. If `pnpm preview` reports that another one is +already running, use that one (`pnpm astro preview status` names its address), stop it +with `pnpm astro preview stop` (or Ctrl-C in its terminal), or start a second one on +another port with `pnpm preview --port 4322 --ignore-lock`. + ## How the site is made `docs/` is the only source of the pages: the documentation tests execute its samples as From f241460bcbff8cbc6db35abdcff07755fc44cac4 Mon Sep 17 00:00:00 2001 From: "Edgar Y. Walker" <> Date: Tue, 17 Nov 2026 03:04:42 -0800 Subject: [PATCH 05/10] ci(docs-site): build only, publish nothing; the site's home is metamorphic-labs (ITL-1170) The deploy job is removed: publishing to GitHub Pages is a separate step the developer enables. The site URL, the site README, the agent instructions and the changelog fragment name metamorphic-labs.github.io instead of nauticalab. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --- .github/workflows/docs-site.yml | 47 +++------------------------------ .zed/rules | 6 ++--- CLAUDE.md | 6 ++--- changelog.d/ITL-1170.md | 9 +++---- site/README.md | 8 +++--- site/astro.config.mjs | 4 +-- 6 files changed, 20 insertions(+), 60 deletions(-) diff --git a/.github/workflows/docs-site.yml b/.github/workflows/docs-site.yml index 25fcae164..60d449ee6 100644 --- a/.github/workflows/docs-site.yml +++ b/.github/workflows/docs-site.yml @@ -1,10 +1,10 @@ name: Documentation site # Builds the documentation site (site/, Astro Starlight) from docs/ and the source on every -# pull request and push, so a broken page, link, anchor or docstring fails CI (ITL-1170). -# The public repository publishes it to GitHub Pages, https://nauticalab.github.io/orcapod-python/ -# (the base path is set in site/astro.config.mjs): when `main` is pushed there (a release -# point, see RELEASING.md) or by hand (Run workflow). The development repository only builds. +# pull request and push to main, so a broken page, link, anchor or docstring fails CI +# (ITL-1170). This workflow only builds: it publishes nothing. Publishing to GitHub Pages +# (https://metamorphic-labs.github.io/orcapod-python/; the base path is set in +# site/astro.config.mjs) is a separate step the developer enables. on: push: @@ -12,10 +12,6 @@ on: pull_request: workflow_dispatch: -env: - # The one repository that publishes the site. - PAGES_REPOSITORY: nauticalab/orcapod-python - permissions: contents: read @@ -28,8 +24,6 @@ jobs: name: Build the site runs-on: ubuntu-latest timeout-minutes: 20 - outputs: - publish: ${{ steps.publish.outputs.publish }} steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: @@ -71,36 +65,3 @@ jobs: - name: Build the site working-directory: site run: pnpm build - - - name: Decide whether to publish - id: publish - run: echo "publish=${{ github.repository == env.PAGES_REPOSITORY && github.event_name != 'pull_request' }}" >> "$GITHUB_OUTPUT" - - - name: Upload the site for GitHub Pages - if: steps.publish.outputs.publish == 'true' - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 - with: - path: site/dist - - deploy: - name: Publish to GitHub Pages - needs: build - if: needs.build.outputs.publish == 'true' - runs-on: ubuntu-latest - timeout-minutes: 10 - permissions: - pages: write - id-token: write - concurrency: - group: pages - cancel-in-progress: false - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - steps: - - name: Configure GitHub Pages - uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0 - - - name: Deploy - id: deployment - uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1 diff --git a/.zed/rules b/.zed/rules index 2ac22d9e4..e2c22b71d 100644 --- a/.zed/rules +++ b/.zed/rules @@ -129,9 +129,9 @@ November 16, 2026, ITL-1170; site/README.md has the commands). mkdocs is gone. entry the signature does not have) fails the build. - Build locally with "cd site && pnpm install && pnpm build"; CI builds the site on every pull request (.github/workflows/docs-site.yml) and tests/test_docs/test_site_content.py runs the - content build without Node. The public repository publishes it to GitHub Pages - (https://nauticalab.github.io/orcapod-python/); the repository that publishes is named once, - in that workflow. + content build without Node. That workflow only builds: publishing to GitHub Pages + (https://metamorphic-labs.github.io/orcapod-python/) is a separate step the developer + enables. An agent never adds a deploy job or changes a Pages setting. ## Linear issue tracking diff --git a/CLAUDE.md b/CLAUDE.md index 2b8b5f134..b5ff73e40 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -133,9 +133,9 @@ November 16, 2026, ITL-1170; `site/README.md` has the commands). mkdocs is gone. entry the signature does not have) fails the build. - Build locally with `cd site && pnpm install && pnpm build`; CI builds the site on every pull request (`.github/workflows/docs-site.yml`) and `tests/test_docs/test_site_content.py` runs - the content build without Node. The public repository publishes it to GitHub Pages - (`https://nauticalab.github.io/orcapod-python/`); the repository that publishes is named - once, in that workflow. + the content build without Node. That workflow only builds: publishing to GitHub Pages + (`https://metamorphic-labs.github.io/orcapod-python/`) is a separate step the developer + enables. An agent never adds a deploy job or changes a Pages setting. ## Linear issue tracking diff --git a/changelog.d/ITL-1170.md b/changelog.d/ITL-1170.md index d86740796..dd7740601 100644 --- a/changelog.d/ITL-1170.md +++ b/changelog.d/ITL-1170.md @@ -1,8 +1,7 @@ ### Changed - The documentation is built as an [Astro Starlight](https://starlight.astro.build) site - from `docs/` and published to GitHub Pages at - <https://nauticalab.github.io/orcapod-python/>. Its API reference is generated from the - source code on every build. mkdocs, mkdocs-material and mkdocstrings are no longer - development dependencies; `griffelib` is. Building the site needs Node and pnpm - (`site/README.md`). (ITL-1170) + from `docs/`, with an API reference generated from the source code on every build. CI + builds the site on every pull request; it is not published yet. mkdocs, mkdocs-material + and mkdocstrings are no longer development dependencies; `griffelib` is. Building the site + needs Node and pnpm (`site/README.md`). (ITL-1170) diff --git a/site/README.md b/site/README.md index 612ed037e..2bd0faab5 100644 --- a/site/README.md +++ b/site/README.md @@ -1,7 +1,7 @@ # The Orcapod documentation site An [Astro Starlight](https://starlight.astro.build) site, built from `../docs/` and the -source code. It is published at <https://nauticalab.github.io/orcapod-python/>. +source code. It is to be published at <https://metamorphic-labs.github.io/orcapod-python/>. ## Build and preview @@ -72,6 +72,6 @@ site has no images, and its `libvips` is under a license the project does not al ## CI and publishing -`.github/workflows/docs-site.yml` builds the site on every pull request and push, and -checks the npm packages' licenses (`../scripts/check_site_licenses.py`). On the public -repository, a push to `main` (a release) or a manual run publishes it to GitHub Pages. +`.github/workflows/docs-site.yml` builds the site on every pull request and push to `main`, +and checks the npm packages' licenses (`../scripts/check_site_licenses.py`). It publishes +nothing: publishing to GitHub Pages is a separate step the developer enables. diff --git a/site/astro.config.mjs b/site/astro.config.mjs index b49a43baa..1fdcaf700 100644 --- a/site/astro.config.mjs +++ b/site/astro.config.mjs @@ -7,8 +7,8 @@ import starlight from '@astrojs/starlight'; import starlightLinksValidator from 'starlight-links-validator'; const repoRoot = fileURLToPath(new URL('..', import.meta.url)); -// Published as a GitHub Pages project page: https://nauticalab.github.io/orcapod-python/ -const site = 'https://nauticalab.github.io'; +// To be published as a GitHub Pages project page: https://metamorphic-labs.github.io/orcapod-python/ +const site = 'https://metamorphic-labs.github.io'; const base = '/orcapod-python/'; /** Write src/content/docs and public from ../docs (pages and generated API reference). */ From 29c930143bd42df748ef19c71a5051a03cbd3012 Mon Sep 17 00:00:00 2001 From: "Edgar Y. Walker" <> Date: Tue, 17 Nov 2026 09:55:13 -0800 Subject: [PATCH 06/10] fix(docs-site): '/' before '*' in generated signatures; refuse links to excluded files (ITL-1170) A positional-only parameter followed by keyword-only ones rendered as '*, /' (StreamBase.map_tags and its siblings); the positional-only separator now closes the positional-only parameters first. A link from a published page to a file under an excluded folder (docs/dev/) now fails the build instead of copying the file into the site. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --- scripts/docs_site_api.py | 12 +++++++----- scripts/docs_site_content.py | 6 ++++-- tests/test_docs/test_site_content.py | 23 +++++++++++++++++++++++ 3 files changed, 34 insertions(+), 7 deletions(-) diff --git a/scripts/docs_site_api.py b/scripts/docs_site_api.py index 1432d6265..ab35ff461 100644 --- a/scripts/docs_site_api.py +++ b/scripts/docs_site_api.py @@ -233,6 +233,13 @@ def _signature(name: str, obj: griffe.Class | griffe.Function) -> str: previous_kind = None for param in params: kind = param.kind + # The positional-only separator closes the positional-only parameters, so it + # comes before the keyword-only separator: ``a, /, *, b``. + if ( + previous_kind is griffe.ParameterKind.positional_only + and kind is not griffe.ParameterKind.positional_only + ): + rendered.append("/") if ( kind is griffe.ParameterKind.keyword_only and not seen_keyword_only @@ -241,11 +248,6 @@ def _signature(name: str, obj: griffe.Class | griffe.Function) -> str: rendered.append("*") if kind is griffe.ParameterKind.keyword_only: seen_keyword_only = True - if ( - previous_kind is griffe.ParameterKind.positional_only - and kind is not griffe.ParameterKind.positional_only - ): - rendered.append("/") star = _STARS.get(kind, "") if kind is not None else "" text = f"{star}{param.name}" if param.annotation is not None: diff --git a/scripts/docs_site_content.py b/scripts/docs_site_content.py index 1f98e10db..2c418d35d 100644 --- a/scripts/docs_site_content.py +++ b/scripts/docs_site_content.py @@ -369,8 +369,8 @@ def resolve(self, page: str, target: str) -> str: """Return the site URL for ``target`` as written on ``page``. Raises: - ContentError: If the target is a page that is not published or a file that - does not exist. + ContentError: If the target is a page that is not published, a file that + does not exist, or a file in an excluded folder. """ if target.startswith("#"): return "#" + self._fragment(page, target[1:]) @@ -390,6 +390,8 @@ def resolve(self, page: str, target: str) -> str: return page_url(resolved, self._base) + sep + fragment if not (self._docs_dir / resolved).is_file(): raise ContentError(f"link {target!r}: docs/{resolved} does not exist") + if resolved.split("/", 1)[0] in EXCLUDED: + raise ContentError(f"link {target!r}: docs/{resolved} is not published") self.assets.add(resolved) return self._base.rstrip("/") + "/" + resolved + sep + fragment diff --git a/tests/test_docs/test_site_content.py b/tests/test_docs/test_site_content.py index 21d412e64..cee041b41 100644 --- a/tests/test_docs/test_site_content.py +++ b/tests/test_docs/test_site_content.py @@ -264,6 +264,19 @@ def test_excluded_folders_are_not_published(tmp_path: Path): assert not (out / "dev").exists() +def test_a_linked_file_in_an_excluded_folder_fails(tmp_path: Path): + pages = { + "concepts/a.md": "# A\n\n[notes](../dev/notes.txt)\n", + "dev/notes.txt": "developer notes\n", + } + docs = make_docs(tmp_path, pages) + proc, _, public = run_build(docs, tmp_path) + assert proc.returncode != 0, "the build should have failed" + assert "docs/concepts/a.md" in proc.stderr + assert "dev/notes.txt is not published" in proc.stderr + assert not (public / "dev").exists() + + def test_an_unknown_top_level_entry_fails(tmp_path: Path): stderr = build_fails(tmp_path, {"index.md": "# H\n", "guides/a.md": "# A\n"}) assert "guides" in stderr @@ -288,6 +301,16 @@ def test_api_page_is_generated_from_the_source(tmp_path: Path): assert "Intro." in text +def test_positional_only_separator_comes_before_keyword_only(tmp_path: Path): + # ``map_tags(self, name_map=None, /, *, drop_unmapped=False, ...)`` + pages = { + "api/streams.md": "# Streams\n\n::: orcapod.core.streams.base.StreamBase.map_tags\n" + } + text = (build_ok(tmp_path, pages) / "api" / "streams.md").read_text() + assert "name_map: Mapping[str, str] | None = None,\n /,\n *,\n" in text + assert "*,\n /," not in text + + def test_api_page_naming_a_missing_object_fails(tmp_path: Path): pages = {"api/types.md": "# Types\n\n::: orcapod.types.NoSuchThing\n"} assert "orcapod.types.NoSuchThing" in build_fails(tmp_path, pages) From 7cd53609afb6079a9592c8a5f01da3b9eca7aef1 Mon Sep 17 00:00:00 2001 From: "Edgar Y. Walker" <> Date: Tue, 17 Nov 2026 09:59:39 -0800 Subject: [PATCH 07/10] ci(docs-site): install pnpm with npm; pnpm/action-setup is not an allowed action (ITL-1170) The workflow failed at startup: the repository's actions policy allows GitHub-owned and verified actions plus a short list, and pnpm/action-setup is not on it. pnpm is installed with npm at the packageManager version instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --- .github/workflows/docs-site.yml | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/.github/workflows/docs-site.yml b/.github/workflows/docs-site.yml index 60d449ee6..d05b88c44 100644 --- a/.github/workflows/docs-site.yml +++ b/.github/workflows/docs-site.yml @@ -40,19 +40,17 @@ jobs: - name: Install Python dependencies run: uv sync --locked --dev --python "3.11" - - name: Install pnpm - # The version is the packageManager field of site/package.json. - uses: pnpm/action-setup@73e46992e05b19abd31f2f3c20e0e7370d762115 # v6.1.1 - with: - package_json_file: site/package.json - - name: Set up Node # The version is the engines.node field of site/package.json. uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0 with: node-version-file: site/package.json - cache: pnpm - cache-dependency-path: site/pnpm-lock.yaml + + - name: Install pnpm + # The exact version in the packageManager field of site/package.json, installed + # with npm: the repository's actions policy does not allow pnpm/action-setup. + working-directory: site + run: npm install --global "$(node -p "require('./package.json').packageManager")" - name: Install site dependencies working-directory: site From f313f6469d99d5aea990051bd85386546fd30bd8 Mon Sep 17 00:00:00 2001 From: "Edgar Y. Walker" <> Date: Tue, 17 Nov 2026 10:01:27 -0800 Subject: [PATCH 08/10] ci(dependency-review): accept GHSA-fc5q-39xc-vjpf (picomatch) as a listed exception (ITL-1170, ITL-1207) picomatch <= 4.0.7 (no patched release) is pulled in by astro, the documentation site's build toolchain. With the developer's approval the dependency review accepts this one advisory (allow-ghsas), tracked by ITL-1207 for removal once a fix is published. docs/dev/security-exceptions.md is the one list of accepted exceptions and its rules; RELEASING.md reviews it at every release, and CLAUDE.md and .zed/rules point to it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --- .github/workflows/run-tests.yml | 5 +++++ .gitignore | 1 + .zed/rules | 4 ++++ CLAUDE.md | 4 ++++ RELEASING.md | 2 ++ docs/dev/security-exceptions.md | 18 ++++++++++++++++++ 6 files changed, 34 insertions(+) create mode 100644 docs/dev/security-exceptions.md diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml index 51ad9e7a0..339a991e8 100644 --- a/.github/workflows/run-tests.yml +++ b/.github/workflows/run-tests.yml @@ -173,3 +173,8 @@ jobs: LGPL-2.0-only, LGPL-2.0-or-later, LGPL-2.1-only, LGPL-2.1-or-later, LGPL-3.0-only, LGPL-3.0-or-later + # Accepted exceptions, each listed in docs/dev/security-exceptions.md. + # GHSA-fc5q-39xc-vjpf (picomatch): build-time only (the documentation site's + # toolchain, site/pnpm-lock.yaml); no patched version as of 2026-11-17. + # Tracked by ITL-1207: remove when a fix is published. + allow-ghsas: GHSA-fc5q-39xc-vjpf diff --git a/.gitignore b/.gitignore index 095fb87a0..0f91c5cb0 100644 --- a/.gitignore +++ b/.gitignore @@ -215,6 +215,7 @@ docs/dev/* !docs/dev/design_issues !docs/dev/notes !docs/dev/orcapod-design.md +!docs/dev/security-exceptions.md # General JSON files at project root /*.json diff --git a/.zed/rules b/.zed/rules index 7e3d073cc..d71652bd4 100644 --- a/.zed/rules +++ b/.zed/rules @@ -336,6 +336,10 @@ What runs where (developer, November 16, 2026; ITL-1181): needs a reason. - The Graphviz `dot` binary is optional. The tests that render a graph to an image skip when `dot` is not on `PATH` and run when it is. +- A security advisory that a CI check accepts (`allow-ghsas` of the dependency review) is + listed in `docs/dev/security-exceptions.md`, the one list of exceptions: one is added only + with the developer's approval and a Linear issue with a due date, and the list is + reviewed at every release. ## Logical type identifiers diff --git a/CLAUDE.md b/CLAUDE.md index 5a980b832..f9513e66a 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -347,6 +347,10 @@ What runs where (developer, November 16, 2026; ITL-1181): needs a reason. - The Graphviz `dot` binary is optional. The tests that render a graph to an image skip when `dot` is not on `PATH` and run when it is. +- A security advisory that a CI check accepts (`allow-ghsas` of the dependency review) is + listed in `docs/dev/security-exceptions.md`, the one list of exceptions: one is added only + with the developer's approval and a Linear issue with a due date, and the list is + reviewed at every release. ## Logical type identifiers diff --git a/RELEASING.md b/RELEASING.md index 5c46d9975..5165b3674 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -105,6 +105,8 @@ All of these hold before the developer runs the Release workflow: 6. **The Linear release is named** (see *Linear Release System*): the open release of the Linear release pipeline has the version `vX.Y.Z`, and nothing merges into `main` until `linear-complete` has finished. Not for a hotfix run, which leaves the open release as it is. +7. **The security exceptions are reviewed**: every exception in + `docs/dev/security-exceptions.md` whose advisory has a published fix is removed. ## Golden hash values diff --git a/docs/dev/security-exceptions.md b/docs/dev/security-exceptions.md new file mode 100644 index 000000000..6bef14572 --- /dev/null +++ b/docs/dev/security-exceptions.md @@ -0,0 +1,18 @@ +# Accepted security advisory exceptions + +This is the one list of security advisories that a CI check is told to accept. Each row +is an exception to a check that would otherwise fail, such as the `Dependency review` job +in `.github/workflows/run-tests.yml` (`allow-ghsas`). + +Rules (developer, November 17, 2026): + +- An exception is added only with the developer's approval. +- Each exception has a Linear issue with a due date, named in its row and in the comment + next to the setting that allows it. +- The list is reviewed at every release (`RELEASING.md`, pre-release checklist). An + exception whose advisory has a published fix is removed: upgrade the package, remove + the setting, delete the row. + +| Advisory | Package and versions | Where allowed | Why accepted | Accepted | Tracking issue | How to check | Removal | +|---|---|---|---|---|---|---|---| +| [GHSA-fc5q-39xc-vjpf](https://github.com/advisories/GHSA-fc5q-39xc-vjpf) (high: ReDoS through single-branch repeated extglobs) | npm `picomatch` <= 4.0.7: 2.3.2 and 4.0.7 in `site/pnpm-lock.yaml`, through `astro` (`unstorage` > `anymatch`, `@astrojs/internal-helpers`, `vite`, `fdir`) | `allow-ghsas` of the `Dependency review` step, `.github/workflows/run-tests.yml` | Build-time only: the documentation site's toolchain matches the repository's own file globs; the published site is static HTML and the Python package does not contain it. No patched version exists (4.0.7 is the latest release) | 2026-11-17 | ITL-1207 (due 2026-12-15) | `gh api /advisories/GHSA-fc5q-39xc-vjpf -q '.vulnerabilities[].first_patched_version'` is no longer `null`; or `cd site && pnpm audit` | Update `site/pnpm-lock.yaml` to a fixed `picomatch` (a newer `astro`, or a pnpm override), remove the GHSA from `allow-ghsas`, delete this row | From cd5373344d66992a1edf12e505e06ca507afb019 Mon Sep 17 00:00:00 2001 From: "Edgar Y. Walker" <> Date: Tue, 17 Nov 2026 10:39:51 -0800 Subject: [PATCH 09/10] feat(docs-site): take the site's address from DOCS_SITE_URL and DOCS_SITE_BASE (ITL-1170) The origin and base path of the documentation site come from the environment, in CI from the repository variables of the same names, with https://metamorphic-labs.github.io/orcapod-python/ when a variable is unset or empty. site_settings in scripts/docs_site_content.py is the one place that reads, normalizes and checks them (base: leading and trailing '/', no scheme, query, fragment, '..', empty segment or whitespace; site: an http(s) origin with no path); a refused value fails the build. astro.config.mjs reads them with --site-settings and passes the base back to the content build, which applies the same rule to --base. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --- .github/workflows/docs-site.yml | 12 ++- .zed/rules | 5 + CLAUDE.md | 5 + changelog.d/ITL-1170.md | 5 +- scripts/docs_site_content.py | 145 ++++++++++++++++++++++++++- site/README.md | 27 ++++- site/astro.config.mjs | 23 ++++- tests/test_docs/test_site_content.py | 122 +++++++++++++++++++++- 8 files changed, 331 insertions(+), 13 deletions(-) diff --git a/.github/workflows/docs-site.yml b/.github/workflows/docs-site.yml index d05b88c44..efa3fd916 100644 --- a/.github/workflows/docs-site.yml +++ b/.github/workflows/docs-site.yml @@ -3,8 +3,13 @@ name: Documentation site # Builds the documentation site (site/, Astro Starlight) from docs/ and the source on every # pull request and push to main, so a broken page, link, anchor or docstring fails CI # (ITL-1170). This workflow only builds: it publishes nothing. Publishing to GitHub Pages -# (https://metamorphic-labs.github.io/orcapod-python/; the base path is set in -# site/astro.config.mjs) is a separate step the developer enables. +# is a separate step the developer enables. +# +# The site's address comes from the repository variables DOCS_SITE_URL (origin, e.g. +# https://docs.example.org) and DOCS_SITE_BASE (base path, e.g. /); one that is not +# defined expands to an empty string, and the build then uses the default, +# https://metamorphic-labs.github.io/orcapod-python/ (site_settings in +# scripts/docs_site_content.py). on: push: @@ -62,4 +67,7 @@ jobs: - name: Build the site working-directory: site + env: + DOCS_SITE_URL: ${{ vars.DOCS_SITE_URL }} + DOCS_SITE_BASE: ${{ vars.DOCS_SITE_BASE }} run: pnpm build diff --git a/.zed/rules b/.zed/rules index d71652bd4..239ea31cc 100644 --- a/.zed/rules +++ b/.zed/rules @@ -132,6 +132,11 @@ November 16, 2026, ITL-1170; site/README.md has the commands). mkdocs is gone. content build without Node. That workflow only builds: publishing to GitHub Pages (https://metamorphic-labs.github.io/orcapod-python/) is a separate step the developer enables. An agent never adds a deploy job or changes a Pages setting. +- The site's address is never hard-coded: DOCS_SITE_URL (origin) and DOCS_SITE_BASE + (base path) come from the environment, in CI from the repository variables of the same + names, with the address above when unset or empty; site_settings in + scripts/docs_site_content.py is the one place that reads and checks them. An agent never + creates or changes those variables. ## Linear issue tracking diff --git a/CLAUDE.md b/CLAUDE.md index f9513e66a..5f85624bc 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -136,6 +136,11 @@ November 16, 2026, ITL-1170; `site/README.md` has the commands). mkdocs is gone. the content build without Node. That workflow only builds: publishing to GitHub Pages (`https://metamorphic-labs.github.io/orcapod-python/`) is a separate step the developer enables. An agent never adds a deploy job or changes a Pages setting. +- The site's address is never hard-coded: `DOCS_SITE_URL` (origin) and `DOCS_SITE_BASE` + (base path) come from the environment, in CI from the repository variables of the same + names, with the address above when unset or empty; `site_settings` in + `scripts/docs_site_content.py` is the one place that reads and checks them. An agent never + creates or changes those variables. ## Linear issue tracking diff --git a/changelog.d/ITL-1170.md b/changelog.d/ITL-1170.md index dd7740601..7ff8d1614 100644 --- a/changelog.d/ITL-1170.md +++ b/changelog.d/ITL-1170.md @@ -4,4 +4,7 @@ from `docs/`, with an API reference generated from the source code on every build. CI builds the site on every pull request; it is not published yet. mkdocs, mkdocs-material and mkdocstrings are no longer development dependencies; `griffelib` is. Building the site - needs Node and pnpm (`site/README.md`). (ITL-1170) + needs Node and pnpm (`site/README.md`). The site's address is configurable: `DOCS_SITE_URL` + (origin) and `DOCS_SITE_BASE` (base path), from the environment or, in CI, the repository + variables of the same names; unset or empty, it is + `https://metamorphic-labs.github.io/orcapod-python/`. (ITL-1170) diff --git a/scripts/docs_site_content.py b/scripts/docs_site_content.py index 2c418d35d..89caad5c5 100644 --- a/scripts/docs_site_content.py +++ b/scripts/docs_site_content.py @@ -23,9 +23,16 @@ (``docs/api/*.md``) are converted the same way, after ``docs_site_api.py`` has replaced each ``::: <object path>`` line with the reference generated from the source. +The site's address is decided here too (``site_settings``): the origin +(``DOCS_SITE_URL``) and the base path (``DOCS_SITE_BASE``) come from the environment, +with ``https://metamorphic-labs.github.io`` and ``/orcapod-python/`` when a variable is +unset or empty. ``--site-settings`` prints them as JSON; ``site/astro.config.mjs`` reads +them from there and passes the base back with ``--base``. + Usage: uv run python scripts/docs_site_content.py + uv run python scripts/docs_site_content.py --site-settings The Astro build runs it (``site/astro.config.mjs``); there is no need to run it by hand. """ @@ -35,19 +42,30 @@ import argparse import html import json +import os import posixpath import re import sys import unicodedata -from collections.abc import Callable, Iterable, Sequence +from collections.abc import Callable, Iterable, Mapping, Sequence from dataclasses import dataclass from pathlib import Path from typing import cast +from urllib.parse import urlsplit REPO_ROOT = Path(__file__).resolve().parents[1] DOCS_DIR = REPO_ROOT / "docs" SITE_DIR = REPO_ROOT / "site" +# The site's address: an origin and a base path, each taken from its environment +# variable when that is set and not empty (a repository variable that is not defined +# expands to an empty string in a workflow), else the default: the GitHub Pages +# project page https://metamorphic-labs.github.io/orcapod-python/. +SITE_URL_VARIABLE = "DOCS_SITE_URL" +SITE_BASE_VARIABLE = "DOCS_SITE_BASE" +DEFAULT_SITE_URL = "https://metamorphic-labs.github.io" +DEFAULT_SITE_BASE = "/orcapod-python/" + # What the site publishes from ``docs/``: these top-level pages, and every ``*.md`` # page directly inside these folders. PUBLISHED_FILES = ("index.md", "getting-started.md", "troubleshooting.md") @@ -158,6 +176,105 @@ class Page: text: str +class SiteSettingsError(Exception): + """The site's origin or base path is not one the site can be built for.""" + + +def normalize_site_url(value: str) -> str: + """Return the site's origin, ``<scheme>://<host>[:<port>]``, from ``value``. + + Args: + value: An ``http`` or ``https`` URL with no path (a trailing ``/`` is allowed), + query or fragment, e.g. ``https://docs.example.org``. + + Returns: + The origin, without a trailing slash. + + Raises: + SiteSettingsError: If ``value`` is not such a URL. + """ + if any(char.isspace() for char in value): + raise SiteSettingsError(f"{value!r} contains whitespace") + if "?" in value or "#" in value: + raise SiteSettingsError(f"{value!r} has a query or a fragment") + parts = urlsplit(value) + scheme = parts.scheme.lower() + if scheme not in ("http", "https") or not parts.netloc: + raise SiteSettingsError(f"{value!r} is not an http or https URL with a host") + try: + _ = parts.port + except ValueError as exc: + raise SiteSettingsError(f"{value!r} has an invalid port") from exc + if parts.username is not None or parts.hostname is None: + raise SiteSettingsError(f"{value!r} is not an origin (a host and a port only)") + if parts.path not in ("", "/"): + raise SiteSettingsError( + f"{value!r} has a path; the path goes into {SITE_BASE_VARIABLE}" + ) + return f"{scheme}://{parts.netloc}" + + +def normalize_site_base(value: str) -> str: + """Return the site's base path from ``value``, starting and ending with ``/``. + + Args: + value: A path, e.g. ``/orcapod-python/``, ``orcapod-python`` or ``/``. + + Returns: + The path with a leading and a trailing ``/`` added where missing. + + Raises: + SiteSettingsError: If ``value`` holds whitespace, a scheme, a query, a fragment, + a backslash, an empty segment (``//``), or a ``.`` or ``..`` segment. + """ + if any(char.isspace() for char in value): + raise SiteSettingsError(f"{value!r} contains whitespace") + if _SCHEME.match(value): + raise SiteSettingsError(f"{value!r} has a scheme; a base is a path only") + for char in "?#\\": + if char in value: + raise SiteSettingsError( + f"{value!r} contains {char!r}; a base is a path only" + ) + if value in ("", "/"): + return "/" + segments = value.removeprefix("/").removesuffix("/").split("/") + for segment in segments: + if segment in ("", ".", ".."): + raise SiteSettingsError( + f"{value!r} has an empty, '.' or '..' segment; a base is a plain path" + ) + return "/" + "/".join(segments) + "/" + + +def site_settings(environ: Mapping[str, str]) -> dict[str, str]: + """Return the site's address, ``{"site": <origin>, "base": <base path>}``. + + Each part comes from its environment variable (``DOCS_SITE_URL``, + ``DOCS_SITE_BASE``) when that is set and not empty, else from its default + (``DEFAULT_SITE_URL``, ``DEFAULT_SITE_BASE``), normalized by + ``normalize_site_url`` and ``normalize_site_base``. + + Args: + environ: The environment to read, e.g. ``os.environ``. + + Raises: + SiteSettingsError: If a variable holds a value the site cannot be built for; + the message names the variable. + """ + url = environ.get(SITE_URL_VARIABLE) or DEFAULT_SITE_URL + base = environ.get(SITE_BASE_VARIABLE) or DEFAULT_SITE_BASE + try: + site = normalize_site_url(url) + except SiteSettingsError as exc: + raise SiteSettingsError(f"{SITE_URL_VARIABLE}: {exc}") from exc + try: + base = normalize_site_base(base) + except SiteSettingsError as exc: + raise SiteSettingsError(f"{SITE_BASE_VARIABLE}: {exc}") from exc + return {"site": site, "base": base} + + def page_url(path: str, base: str = "/") -> str: """Return the site URL of the page at ``path`` (relative to ``docs/``). @@ -474,12 +591,34 @@ def main(argv: Sequence[str] | None = None) -> int: "--out", type=Path, default=SITE_DIR / "src" / "content" / "docs" ) _ = parser.add_argument("--public", type=Path, default=SITE_DIR / "public") - _ = parser.add_argument("--base", default="/") + _ = parser.add_argument( + "--base", default="/", help="the site's base path (normalize_site_base)" + ) + _ = parser.add_argument( + "--site-settings", + action="store_true", + help=( + f"print the site's address from {SITE_URL_VARIABLE} and " + f"{SITE_BASE_VARIABLE} as JSON and exit" + ), + ) args = parser.parse_args(argv) + if cast(bool, args.site_settings): + try: + settings = site_settings(os.environ) + except SiteSettingsError as exc: + print(f"error: {exc}", file=sys.stderr) + return 1 + print(json.dumps(settings)) + return 0 docs_dir = cast(Path, args.docs) out_dir = cast(Path, args.out) public_dir = cast(Path, args.public) - base = cast(str, args.base) + try: + base = normalize_site_base(cast(str, args.base)) + except SiteSettingsError as exc: + print(f"error: --base: {exc}", file=sys.stderr) + return 1 # Run as a script, scripts/ is on sys.path; the API generator imports griffe, so # it is imported only when the content is built. diff --git a/site/README.md b/site/README.md index 2bd0faab5..3072c836e 100644 --- a/site/README.md +++ b/site/README.md @@ -1,7 +1,8 @@ # The Orcapod documentation site An [Astro Starlight](https://starlight.astro.build) site, built from `../docs/` and the -source code. It is to be published at <https://metamorphic-labs.github.io/orcapod-python/>. +source code. It is to be published at <https://metamorphic-labs.github.io/orcapod-python/>, +the default address (see [The site's address](#the-sites-address)). ## Build and preview @@ -13,7 +14,7 @@ environment (`uv sync --dev` at the repository root). cd site pnpm install --frozen-lockfile # once, and after package.json or the lockfile changes pnpm build # build the site into site/dist -pnpm preview # serve site/dist at http://localhost:4321/orcapod-python/ +pnpm preview # serve site/dist at http://localhost:4321<base>, by default /orcapod-python/ pnpm dev # live preview while editing docs/ or the source ``` @@ -60,10 +61,30 @@ reference when that object is documented. Planned with the v0.4 content update (ITL-1170): API pages generated from each public module's `__all__` instead of these lists. +## The site's address + +The site's origin and base path are taken from two environment variables, each used only +when it is set and not empty: `DOCS_SITE_URL`, the origin (`https://docs.example.org`; an +`http` or `https` URL with no path), and `DOCS_SITE_BASE`, the base path (`/`, +`/orcapod-python/`; a leading and a trailing `/` are added where missing). Unset or empty, +they are `https://metamorphic-labs.github.io` and `/orcapod-python/`. One place decides +them, `site_settings` in `../scripts/docs_site_content.py`: `astro.config.mjs` reads them +with `--site-settings` and passes the base back to the content build, and a value that +script refuses (a base with a scheme, a query, `..` or whitespace; a site URL that is not +`http` or `https`, or that has a path) fails the build. + +```sh +DOCS_SITE_URL=https://docs.example.org DOCS_SITE_BASE=/ pnpm build +``` + +In CI, the build step takes them from the repository variables of the same names +(Settings > Secrets and variables > Actions > Variables). A custom domain is +`DOCS_SITE_URL=https://<domain>` with `DOCS_SITE_BASE=/`. + ## What is committed `package.json`, `pnpm-lock.yaml` (exact versions), `pnpm-workspace.yaml`, -`astro.config.mjs` (site settings, base path, sidebar), `src/content.config.ts` and +`astro.config.mjs` (site settings, sidebar), `src/content.config.ts` and this file. `node_modules/`, `dist/`, `.astro/`, `src/content/docs/` and `public/` are generated. diff --git a/site/astro.config.mjs b/site/astro.config.mjs index 1fdcaf700..0ea7e0fb4 100644 --- a/site/astro.config.mjs +++ b/site/astro.config.mjs @@ -7,9 +7,26 @@ import starlight from '@astrojs/starlight'; import starlightLinksValidator from 'starlight-links-validator'; const repoRoot = fileURLToPath(new URL('..', import.meta.url)); -// To be published as a GitHub Pages project page: https://metamorphic-labs.github.io/orcapod-python/ -const site = 'https://metamorphic-labs.github.io'; -const base = '/orcapod-python/'; + +/** + * The site's address: DOCS_SITE_URL (origin) and DOCS_SITE_BASE (base path) from the + * environment, or the defaults (https://metamorphic-labs.github.io/orcapod-python/). + * The rule is site_settings in scripts/docs_site_content.py; a value it refuses fails + * the build. + */ +function siteSettings() { + const result = spawnSync( + 'uv', + ['run', 'python', 'scripts/docs_site_content.py', '--site-settings'], + { cwd: repoRoot, encoding: 'utf-8', stdio: ['ignore', 'pipe', 'inherit'] }, + ); + if (result.status !== 0) { + throw new Error('invalid site address (DOCS_SITE_URL, DOCS_SITE_BASE; scripts/docs_site_content.py)'); + } + return JSON.parse(result.stdout); +} + +const { site, base } = siteSettings(); /** Write src/content/docs and public from ../docs (pages and generated API reference). */ function buildContent() { diff --git a/tests/test_docs/test_site_content.py b/tests/test_docs/test_site_content.py index cee041b41..11a6f1fee 100644 --- a/tests/test_docs/test_site_content.py +++ b/tests/test_docs/test_site_content.py @@ -4,7 +4,7 @@ converts every published page and generates the API reference from the source. It fails on a broken link, a page that is neither published nor excluded, an object an API page names that does not exist, or a docstring griffe reports a problem with; these -tests hold it to that, without Node. The site build itself (``pnpm build`` in +tests hold it to that, and to the site's address (``--site-settings``), without Node. The site build itself (``pnpm build`` in ``site/``, which also validates every link and anchor) runs in the ``docs-site`` workflow. @@ -13,9 +13,12 @@ from __future__ import annotations +import json +import os import subprocess import sys from pathlib import Path +from typing import cast import pytest @@ -326,3 +329,120 @@ def test_a_removed_page_leaves_the_site(tmp_path: Path): assert proc.returncode == 0, proc.stderr assert not (out / "concepts").exists() assert (out / "index.md").is_file() + + +# --------------------------------------------------------------------------- +# The site's address +# --------------------------------------------------------------------------- + + +@pytest.mark.parametrize(("base", "prefix"), [("/", ""), ("/other/", "/other")]) +def test_links_and_anchors_follow_the_base(tmp_path: Path, base: str, prefix: str): + pages = { + "index.md": ( + "# Home\n\n" + "[s](concepts/sources.md#derivedsource-tags_as_data) [h](#top)" + " [d](tutorial/data.py)\n" + ), + "concepts/sources.md": ( + "# Sources\n\n[home](../index.md)\n\n## `DerivedSource` -- tags_as_data\n" + ), + "tutorial/data.py": "x = 1\n", + } + home = (build_ok(tmp_path, pages, base=base) / "index.md").read_text() + assert f"[s]({prefix}/concepts/sources/#derivedsource----tags_as_data)" in home + assert "[h](#top)" in home + assert f"[d]({prefix}/tutorial/data.py)" in home + sources = (tmp_path / "out" / "concepts" / "sources.md").read_text() + assert f"[home]({prefix}/)" in sources + + +@pytest.mark.parametrize("given", ["other", "/other", "other/", "/other/"]) +def test_the_base_is_normalized(tmp_path: Path, given: str): + pages = {"index.md": "# H\n\n[s](concepts/a.md)\n", "concepts/a.md": "# A\n"} + home = (build_ok(tmp_path, pages, base=given) / "index.md").read_text() + assert "[s](/other/concepts/a/)" in home + + +def test_an_invalid_base_fails(tmp_path: Path): + proc, _, _ = run_build(make_docs(tmp_path, {"index.md": "# H\n"}), tmp_path, "/../") + assert proc.returncode != 0 + assert "--base" in proc.stderr + + +def site_settings(env: dict[str, str]) -> subprocess.CompletedProcess[str]: + environ = { + k: v + for k, v in os.environ.items() + if k not in ("DOCS_SITE_URL", "DOCS_SITE_BASE") + } + return subprocess.run( + [sys.executable, str(SCRIPT), "--site-settings"], + capture_output=True, + text=True, + timeout=60, + check=False, + env={**environ, **env}, + ) + + +def settings_ok(env: dict[str, str]) -> dict[str, str]: + proc = site_settings(env) + assert proc.returncode == 0, proc.stderr + return cast(dict[str, str], json.loads(proc.stdout)) + + +@pytest.mark.parametrize( + "env", [{}, {"DOCS_SITE_URL": "", "DOCS_SITE_BASE": ""}], ids=["unset", "empty"] +) +def test_the_default_address(env: dict[str, str]): + assert settings_ok(env) == { + "site": "https://metamorphic-labs.github.io", + "base": "/orcapod-python/", + } + + +def test_a_custom_domain(): + env = {"DOCS_SITE_URL": "https://docs.example.org", "DOCS_SITE_BASE": "/"} + assert settings_ok(env) == {"site": "https://docs.example.org", "base": "/"} + + +@pytest.mark.parametrize( + ("env", "expected"), + [ + ({"DOCS_SITE_URL": "https://docs.example.org/"}, "https://docs.example.org"), + ({"DOCS_SITE_URL": "HTTP://localhost:8080"}, "http://localhost:8080"), + ({"DOCS_SITE_BASE": "docs"}, "/docs/"), + ({"DOCS_SITE_BASE": "/a/b"}, "/a/b/"), + ], +) +def test_the_address_is_normalized(env: dict[str, str], expected: str): + settings = settings_ok(env) + assert expected in (settings["site"], settings["base"]) + + +@pytest.mark.parametrize( + "env", + [ + {"DOCS_SITE_URL": "ftp://docs.example.org"}, + {"DOCS_SITE_URL": "docs.example.org"}, + {"DOCS_SITE_URL": "https://docs.example.org/orcapod/"}, + {"DOCS_SITE_URL": "https://docs.example.org?x=1"}, + {"DOCS_SITE_URL": "https://user@docs.example.org"}, + {"DOCS_SITE_URL": "https://docs.example.org:port"}, + {"DOCS_SITE_URL": " https://docs.example.org"}, + {"DOCS_SITE_BASE": "https://docs.example.org/"}, + {"DOCS_SITE_BASE": "/docs?x=1"}, + {"DOCS_SITE_BASE": "/docs#top"}, + {"DOCS_SITE_BASE": "/a/../b/"}, + {"DOCS_SITE_BASE": "/a//b/"}, + {"DOCS_SITE_BASE": "/my docs/"}, + {"DOCS_SITE_BASE": "/docs/\n"}, + ], +) +def test_an_invalid_address_is_refused(env: dict[str, str]): + proc = site_settings(env) + assert proc.returncode != 0 + assert proc.stdout == "" + (variable,) = env + assert variable in proc.stderr From 328824b1ce37335e44db1ebcd72bc220a6268c30 Mon Sep 17 00:00:00 2001 From: "Edgar Y. Walker" <> Date: Tue, 17 Nov 2026 11:03:51 -0800 Subject: [PATCH 10/10] fix(docs-site): number repeated heading anchors as github-slugger does; rewrite reference definitions (ITL-1170) heading_anchors now records every anchor it gives, as github-slugger does, so headings 'Repeat', 'Repeat', 'Repeat-1' map to 'repeat', 'repeat-1', 'repeat-1-1' instead of two 'repeat-1'. A reference definition ('[label]: target') has its target resolved by the same LinkResolver as an inline link (base, anchors, publish check, copied file); a footnote and a definition inside a code block are left as they are. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --- scripts/docs_site_content.py | 31 +++++++++++++++++++++---- tests/test_docs/test_site_content.py | 34 ++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+), 5 deletions(-) diff --git a/scripts/docs_site_content.py b/scripts/docs_site_content.py index 89caad5c5..1e6b175fb 100644 --- a/scripts/docs_site_content.py +++ b/scripts/docs_site_content.py @@ -99,6 +99,10 @@ _FENCE = re.compile(r"^ *(?P<fence>`{3,}|~{3,})") _DIRECTIVE_COLONS = re.compile(r"^ *(:{3,})") _INLINE_LINK = re.compile(r"(\]\()(?P<target>[^)\s]+)(?P<rest>(?: +\"[^\"]*\")?\))") +# A reference definition, ``[label]: target "title"`` (not a footnote, ``[^1]: text``). +_REFERENCE_DEFINITION = re.compile( + r"^(?P<lead> {0,3}\[(?!\^)[^\]]+\]:[ \t]*)(?P<target><[^<>\s]*>|[^<\s]\S*)(?P<rest>.*)$" +) _INLINE_CODE = re.compile(r"(`+)(?:.*?)\1") _SCHEME = re.compile(r"^[a-zA-Z][a-zA-Z0-9+.-]*:") @@ -136,7 +140,9 @@ def heading_anchors(markdown: str) -> dict[str, str]: """ anchors: dict[str, str] = {} seen_mkdocs: set[str] = set() - seen_starlight: dict[str, int] = {} + # github-slugger's occurrences: every anchor it has given, and for a repeated + # slug the last number it appended. + occurrences: dict[str, int] = {} fence: str | None = None for line in markdown.splitlines(): if fence is not None: @@ -158,9 +164,12 @@ def heading_anchors(markdown: str) -> dict[str, str]: candidate = f"{mk}_{n}" seen_mkdocs.add(candidate) sl = starlight_slug(text) - count = seen_starlight.get(sl, 0) - seen_starlight[sl] = count + 1 - anchors[candidate] = f"{sl}-{count}" if count else sl + anchor = sl + while anchor in occurrences: + occurrences[sl] += 1 + anchor = f"{sl}-{occurrences[sl]}" + occurrences[anchor] = 0 + anchors[candidate] = anchor return anchors @@ -444,7 +453,19 @@ def convert_admonitions(lines: Sequence[str]) -> list[str]: def _convert_link_targets(line: str, resolve: Callable[[str], str]) -> str: - """Rewrite the targets of inline links on ``line``, outside inline code spans.""" + """Rewrite the link targets on ``line``. + + The target of a reference definition (``[label]: target``), or the targets of the + inline links outside inline code spans. + """ + definition = _REFERENCE_DEFINITION.match(line) + if definition is not None: + target = definition.group("target") + if target.startswith("<"): + target = "<" + resolve(target[1:-1]) + ">" + else: + target = resolve(target) + return definition.group("lead") + target + definition.group("rest") pieces: list[str] = [] pos = 0 for code in _INLINE_CODE.finditer(line): diff --git a/tests/test_docs/test_site_content.py b/tests/test_docs/test_site_content.py index 11a6f1fee..1561c650f 100644 --- a/tests/test_docs/test_site_content.py +++ b/tests/test_docs/test_site_content.py @@ -213,6 +213,40 @@ def test_mkdocs_anchors_become_starlight_anchors(tmp_path: Path): assert "[b](#same-page-twice-1)" in home +def test_a_repeated_heading_does_not_take_an_existing_anchor(tmp_path: Path): + # github-slugger gives the third heading ``repeat-1-1``: ``repeat-1`` is taken. + page = ( + "# P\n\n[b](#repeat_1) [c](#repeat-1)\n\n" + "## Repeat\n\n## Repeat\n\n## Repeat-1\n" + ) + text = (build_ok(tmp_path, {"index.md": page}) / "index.md").read_text() + assert "[b](#repeat-1) [c](#repeat-1-1)" in text + + +def test_reference_definitions_are_rewritten(tmp_path: Path): + pages = { + "index.md": ( + "# Home\n\nSee [s][src] and [d][data].\n\n" + '[src]: concepts/sources.md#top "Sources"\n' + " [data]: <tutorial/data.py>\n" + "[ext]: https://example.org/a.md\n" + "\n```markdown\n[x]: nope.md\n```\n" + ), + "concepts/sources.md": "# Sources\n\n## Top\n", + "tutorial/data.py": "x = 1\n", + } + text = (build_ok(tmp_path, pages, base="/b/") / "index.md").read_text() + assert '[src]: /b/concepts/sources/#top "Sources"\n' in text + assert " [data]: </b/tutorial/data.py>\n" in text + assert "[ext]: https://example.org/a.md\n" in text + assert "[x]: nope.md" in text + + +def test_a_broken_reference_definition_fails(tmp_path: Path): + stderr = build_fails(tmp_path, {"index.md": "# H\n\n[x]: missing.md\n"}) + assert "is not a published page" in stderr + + def test_links_in_code_are_not_rewritten(tmp_path: Path): page = "# P\n\n`[x](nope.md)`\n\n```markdown\n[y](nope.md)\n```\n" text = (build_ok(tmp_path, {"index.md": page}) / "index.md").read_text()