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.3.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.3-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scrolly-0.2.3.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.3.tar.gz
Algorithm Hash digest
SHA256 efc34fb7559f891037b739541316eb63a8324ccacf646d6a29649cf3b507afea
MD5 9a19ffb499f99c4dfb0cdacb7555ae7a
BLAKE2b-256 c3e419088572cdbae5082fbb62309340bb8bb057ad6865c13cc180d1fadc4bf9

See more details on using hashes here.

Provenance

The following attestation bundles were made for scrolly-0.2.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: scrolly-0.2.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a77ac972e90c312f5d7698de68f358fa2001f7205d5a02f5cd8bd39e9c98f5fd
MD5 2676e8086d83f83f205f42c4b6e18ef3
BLAKE2b-256 0a0a9cdedce0bdc11357093ee78c74ea9e1049471311de904867219a990de20a

See more details on using hashes here.

Provenance

The following attestation bundles were made for scrolly-0.2.3-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