README.md

twoslash-demo

Demo crate for rustdoc-twoslash — rustdoc with IDE-style type hover annotations on code blocks.

Live demo: https://twoslash-rustdoc.vercel.app

Build & Deploy

Requires the rustdoc-twoslash fork built locally.

# Build docs with twoslash annotations
RUSTDOC_TWOSLASH=1 \
  RUSTDOC=/path/to/rustdoc-twoslash/build/host/stage1/bin/rustdoc \
  RUSTC=/path/to/rustdoc-twoslash/build/host/stage1/bin/rustc \
  cargo doc --no-deps

# Copy built docs and push (auto-deploys to Vercel)
rsync -a --delete --exclude='.vercel' target/doc/ docs/
git add docs/ && git commit -m "docs: update" && git push

Related

• tmm/rustdoc-twoslash — modified src/librustdoc/ files and patch
• wevm/vocs/twoslash-rust — rust-analyzer integration library