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.0.tar.gz (78.5 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.0-py3-none-any.whl (100.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scrolly-0.2.0.tar.gz
  • Upload date:
  • Size: 78.5 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.0.tar.gz
Algorithm Hash digest
SHA256 0b21e3d2c1cd240ee2088b212f3c2196574fd7d5c9e431066b2dcf3a060de163
MD5 4edf60ffce243e67ae65e5b35585bce0
BLAKE2b-256 27222d84dab6b8b9ec0528f07ee080e2092a4c3c7daa3a21f946696be2286a2d

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: scrolly-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 100.1 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1953f211b9f033bdca0c1458631c3cbac901591e74c18be2324da0770ae5a8aa
MD5 46feddbe2bc292f807c113c3534423a8
BLAKE2b-256 ee32f7c9f4ee723c295b1061f9ba4de03341c322fd740b9bcbd4b42e2e8ee5b6

See more details on using hashes here.

Provenance

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