Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Where this book sits

wisp-chart is one of three mdBooks composed into the same GitHub Pages artifact.

flowchart LR
    Screen["/Screen/<br/>screen recorder"]:::shell
    Wisp["/Screen/wisp/<br/>wisp renderer"]:::wisp
    Chart["/Screen/wisp-chart/<br/>chart compositions"]:::chart
    Api["/Screen/api/<br/>rustdoc"]:::api

    Chart -->|depends on| Wisp
    Screen -->|uses| Wisp
    Screen -->|uses| Chart

    classDef shell fill:#1e293b,stroke:#475569,color:#e2e8f0
    classDef wisp fill:#7c2d12,stroke:#ea580c,color:#fed7aa
    classDef chart fill:#312e81,stroke:#6366f1,color:#e0e7ff
    classDef api fill:#374151,stroke:#9ca3af,color:#f3f4f6

Cross-book tags

The mdbook-preprocessor-cross tags resolve per-book. Inside this book:

TagRenders as
/Screen/wisp/wisp/overview.html/Screen/wisp/wisp/overview.html
./charts/gantt/api.html./charts/gantt/api.html (relative — same book)
````admonish info title="Cross-book link convention"
This is one of two sibling mdBooks deployed to the same GitHub
Pages site:
  • Project book/Screen/ (recorder + capture + encoder + Tauri shell).
  • Wisp book/Screen/wisp/ (renderer-only reference; publishable to crates.io independently).

Cross-references in either book go through the mdbook-preprocessor-cross preprocessor so URLs adapt per book:

  • \{\{wisp-link path/to/chunk\}\} — emits a relative URL inside the wisp book, an absolute /Screen/wisp/path/to/chunk.html URL from the project book.
  • \{\{shared path/to/fragment.md\}\} — inlines a markdown fragment from _docs/shared/ (this snippet you're reading is one).

Plain markdown links from the wisp book back to the project use absolute URLs (/Screen/...) since the inverse direction is single-target.

` | inlined from `_docs/shared/` |

Inside the screen + wisp books, the same `{{wisp-chart-link}}`
tag emits an absolute URL to `/Screen/wisp-chart/...`. Authors
write the tag once; the preprocessor adapts per book.