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.

CI PyPI Python License

Installation

pip install scrolly

Or with uv:

uv tool install scrolly

Quickstart

scrolly build examples/worked-example/deck.deck.json --out /tmp/scrolly-out --force
open /tmp/scrolly-out/index.html

See examples/worked-example/ for a reference 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.1.tar.gz (103.2 kB 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.1-py3-none-any.whl (147.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scrolly-0.2.1.tar.gz
Algorithm Hash digest
SHA256 34dbacefad3b2bfc9ea04b9da7ae4081196ce430191362324ff02793d0249fc1
MD5 1f11da85349e3e30fe4484c98ec7e54c
BLAKE2b-256 7de5eb3acff8f59b471bd393ad02ee18aaafb7b20d07aea1b7efef3f8fa49fd5

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: scrolly-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 147.5 kB
  • 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2bea13eac65375c2c0d461133199d5b4721ffec67dc2bd0f697ff7ae75151ae0
MD5 99dec875cb2a58adf7bf532e5f7d747e
BLAKE2b-256 63b8f5c81a5861bc8fe552b6a8b021080421f248a9cef4cacb0674b91631dc57

See more details on using hashes here.

Provenance

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