mkdocs.yml

site_name: Rezi
site_description: A deterministic, native-backed terminal UI framework for Node.js and Bun built on the Zireael engine.
site_url: https://rezitui.dev/
repo_url: https://github.com/RtlZeroMemory/Rezi
repo_name: RtlZeroMemory/Rezi
edit_uri: edit/main/docs/
docs_dir: docs
site_dir: out/site

theme:
  name: material
  custom_dir: docs/overrides
  language: en
  icon:
    repo: fontawesome/brands/github
  features:
    - announce.dismiss
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - content.tabs.link
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search:
      lang: en

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - def_list
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
  - toc:
      permalink: true

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://unpkg.com/mermaid@10.9.1/dist/mermaid.min.js
  - javascripts/mermaid-init.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/RtlZeroMemory/Rezi
  generator: false
  version:
    provider: mike

copyright: Copyright © 2025-2026 RtlZeroMemory

nav:
  - Home: index.md
  - Design Principles: design-principles.md
  - Getting Started:
      - Install: getting-started/install.md
      - Create Rezi: getting-started/create-rezi.md
      - Quickstart: getting-started/quickstart.md
      - Constraints (10 min): getting-started/constraints-quickstart.md
      - JSX: getting-started/jsx.md
      - Examples: getting-started/examples.md
      - FAQ: getting-started/faq.md
  - Guides:
      - Index: guide/index.md
      - Concepts: guide/concepts.md
      - Composition: guide/composition.md
      - Animation: guide/animation.md
      - Runtime & Layout: guide/runtime-and-layout.md
      - Lifecycle & Updates: guide/lifecycle-and-updates.md
      - Error Handling: guide/error-handling.md
      - Routing: guide/routing.md
      - Layout: guide/layout.md
      - Layout Decision Tree: guide/layout-decision-tree.md
      - Constraints: guide/constraints.md
      - Constraint Patterns: guide/constraint-patterns.md
      - Constraint Recipes: guide/constraint-recipes.md
      - Constraint Demos: guide/constraint-demos.md
      - Styling with Constraints: guide/styling-with-constraints.md
      - Debugging Constraints: guide/debugging-constraints.md
      - Performance with Constraints: guide/performance-with-constraints.md
      - Input & Focus: guide/input-and-focus.md
      - Mouse Support: guide/mouse-support.md
      - Styling: guide/styling.md
      - Text Style Internals: guide/text-style-internals.md
      - Widget Authoring: guide/widget-authoring.md
      - Graphics: guide/graphics.md
      - Performance: guide/performance.md
      - Debugging: guide/debugging.md
      - Testing: guide/testing.md
      - Record & Replay: guide/record-replay.md
      - Hooks Reference: guide/hooks-reference.md
      - Recommended Patterns: guide/recommended-patterns.md
  - Reference:
      - Benchmarks: benchmarks.md
      - Glossary: reference/glossary.md
      - Constraints API: reference/constraints-api.md
      - Constraint Expressions: reference/constraint-expressions.md
  - Widgets:
      - Overview: widgets/index.md
      - Stability: widgets/stability.md
      - Primitives:
          - Text: widgets/text.md
          - Box: widgets/box.md
          - Row / Column: widgets/stack.md
          - Spacer: widgets/spacer.md
          - Divider: widgets/divider.md
      - Indicators:
          - Icon: widgets/icon.md
          - Spinner: widgets/spinner.md
          - Progress: widgets/progress.md
          - Skeleton: widgets/skeleton.md
          - RichText: widgets/rich-text.md
          - Kbd: widgets/kbd.md
          - Badge: widgets/badge.md
          - Status: widgets/status.md
          - Tag: widgets/tag.md
      - Inputs:
          - Button: widgets/button.md
          - Input: widgets/input.md
          - Textarea: widgets/textarea.md
          - Slider: widgets/slider.md
          - Checkbox: widgets/checkbox.md
          - Radio Group: widgets/radio-group.md
          - Select: widgets/select.md
          - Field: widgets/field.md
      - Navigation:
          - Tabs: widgets/tabs.md
          - Accordion: widgets/accordion.md
          - Breadcrumb: widgets/breadcrumb.md
          - Link: widgets/link.md
          - Pagination: widgets/pagination.md
      - Data:
          - Table: widgets/table.md
          - Virtual List: widgets/virtual-list.md
          - Tree: widgets/tree.md
      - Overlays:
          - Layers: widgets/layers.md
          - Modal: widgets/modal.md
          - Dialog: widgets/dialog.md
          - Dropdown: widgets/dropdown.md
          - Layer: widgets/layer.md
          - Toast: widgets/toast.md
          - Focus Announcer: widgets/focus-announcer.md
          - Focus Zone: widgets/focus-zone.md
          - Focus Trap: widgets/focus-trap.md
      - Layout:
          - Grid: widgets/grid.md
          - Split Pane: widgets/split-pane.md
          - Panel Group: widgets/panel-group.md
          - Resizable Panel: widgets/resizable-panel.md
      - Advanced:
          - Command Palette: widgets/command-palette.md
          - File Picker: widgets/file-picker.md
          - File Tree Explorer: widgets/file-tree-explorer.md
          - Code Editor: widgets/code-editor.md
          - Diff Viewer: widgets/diff-viewer.md
          - Logs Console: widgets/logs-console.md
          - Tool Approval Dialog: widgets/tool-approval-dialog.md
      - Charts:
          - Gauge: widgets/gauge.md
          - Sparkline: widgets/sparkline.md
          - Bar Chart: widgets/bar-chart.md
          - Mini Chart: widgets/mini-chart.md
      - Graphics:
          - Canvas: widgets/canvas.md
          - Image: widgets/image.md
          - Line Chart: widgets/line-chart.md
          - Scatter: widgets/scatter.md
          - Heatmap: widgets/heatmap.md
      - Feedback:
          - Callout: widgets/callout.md
          - Error Display: widgets/error-display.md
          - Error Boundary: widgets/error-boundary.md
          - Empty: widgets/empty.md
  - Styling:
      - Overview: styling/index.md
      - Default Recipe Behavior: styling/defaults.md
      - Design System: design-system.md
      - Style Props: styling/style-props.md
      - Theme: styling/theme.md
      - Icons: styling/icons.md
      - Focus Styles: styling/focus-styles.md
  - Recipes:
      - Overview: recipes/index.md
      - Form Validation: recipes/form-validation.md
      - Modal Confirmation: recipes/modal-confirmation.md
      - Keyboard Shortcuts: recipes/keyboard-shortcuts.md
      - Loading States: recipes/loading-states.md
      - Data Table: recipes/data-table.md
  - Architecture:
      - Overview: architecture/index.md
      - Terminal I/O Contract: terminal-io-contract.md
      - Backend:
          - Node Backend: backend/node.md
          - Worker Model: backend/worker-model.md
          - Native Addon: backend/native.md
          - Engine Config: backend/engine-config.md
          - Terminal Caps: backend/terminal-caps.md
      - Protocol:
          - Overview: protocol/index.md
          - Event Batches (ZREV): protocol/zrev.md
          - Drawlists (ZRDL): protocol/zrdl.md
          - Cursor: protocol/cursor.md
          - Versioning: protocol/versioning.md
          - ABI: protocol/abi.md
          - Safety Rules: protocol/safety.md
  - API:
      - Overview: api.md
      - Packages:
          - Overview: packages/index.md
          - "@rezi-ui/core": packages/core.md
          - "@rezi-ui/node": packages/node.md
          - "@rezi-ui/native": packages/native.md
          - "@rezi-ui/jsx": packages/jsx.md
          - "@rezi-ui/testkit": packages/testkit.md
          - create-rezi CLI: packages/create-rezi.md
  - Developer:
      - Contributing: dev/contributing.md
      - Repo Layout: dev/repo-layout.md
      - Build: dev/build.md
      - Testing: dev/testing.md
      - Live PTY Debugging: dev/live-pty-debugging.md
      - Code Standards: dev/code-standards.md
      - Perf Regressions: dev/perf-regressions.md
      - Repro Replay: dev/repro-replay.md
      - Releasing: dev/releasing.md
      - Docs: dev/docs.md
      - Style Guide: dev/style-guide.md
      - JSX Internals: dev/jsx-internals.md
      - Maintaining Docs: maintainers.md