Skip to main content

CLI that compiles a JSON5 deck + slide files into a self-contained 2D-canvas HTML presentation.

Project description

scrolly

Compile a JSON5 deck into a self-contained, scrollable 2D-canvas HTML presentation.

Liked by humans; understood by agents.

scrolly — scroll-driven 2D-canvas presentations

CI PyPI Python License

Installation

pip install scrolly

Or with uv:

uv tool install scrolly

Quickstart

scrolly build examples/stacked-diffs/deck.deck.json --out /tmp/scrolly-out --force
open /tmp/scrolly-out/index.html

See examples/stacked-diffs/ for a complete example deck.

Source format

A deck is a .deck.json manifest plus one .slide.json per slide. Both files are parsed as JSON5 but kept on the .json extension — a deliberate agent-first choice so common tooling that defaults to *.json continues to work; the JSON5 superset is what authors and agents actually write.

Supported image formats

Image assets referenced from slides may use any of the following formats: .png, .jpg / .jpeg, .svg, .gif, .webp, .avif.

License

MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scrolly-0.2.2.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scrolly-0.2.2-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file scrolly-0.2.2.tar.gz.

File metadata

  • Download URL: scrolly-0.2.2.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scrolly-0.2.2.tar.gz
Algorithm Hash digest
SHA256 6dbdc4f0110892cec83051ea24974c3a3e93b0fa1dc5884160f2e874964a0e39
MD5 b7a5581f027b67c527412cff33ff0d07
BLAKE2b-256 b2921aaefa54cea8f6316415df9cb0508de3ba5a8ab94ed6b8afeedbfdafd1f5

See more details on using hashes here.

Provenance

The following attestation bundles were made for scrolly-0.2.2.tar.gz:

Publisher: release_tag.yml on bertpl/scrolly

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scrolly-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: scrolly-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scrolly-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 eea8802190ccf0c0807eb12f0a307272eab782178ad8c6b1b9436fc5fdf5bf99
MD5 e9990a8cf5248e7b4a98469139e914e3
BLAKE2b-256 0eecd24b3cbbed273d141cc88883ca3a59ce02eb77c2bfa8943486f5359fefaf

See more details on using hashes here.

Provenance

The following attestation bundles were made for scrolly-0.2.2-py3-none-any.whl:

Publisher: release_tag.yml on bertpl/scrolly

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page