Metadata-Version: 2.4
Name: scrolly
Version: 0.1.3
Summary: CLI that compiles a JSON5 deck + slide files into a self-contained 2D-canvas HTML presentation.
Project-URL: Source, https://github.com/bertpl/scrolly
Project-URL: Changelog, https://github.com/bertpl/scrolly/blob/main/CHANGELOG.md
Project-URL: Issues, https://github.com/bertpl/scrolly/issues
Author-email: Bert Pluymers <bert.pluymers@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: cli,html,presentation,scrollytelling,slides
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Multimedia :: Graphics :: Presentation
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Python: >=3.11
Requires-Dist: click>=8.2.0
Requires-Dist: jinja2>=3.1
Requires-Dist: json5>=0.13.0
Requires-Dist: markdown>=3.4
Requires-Dist: pydantic>=2.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.0.0
Description-Content-Type: text/markdown

# scrolly

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

[![CI](https://github.com/bertpl/scrolly/actions/workflows/push_to_main.yml/badge.svg)](https://github.com/bertpl/scrolly/actions/workflows/push_to_main.yml)
[![PyPI](https://img.shields.io/pypi/v/scrolly.svg)](https://pypi.org/project/scrolly/)
[![Python](https://img.shields.io/pypi/pyversions/scrolly.svg)](https://pypi.org/project/scrolly/)
[![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/bertpl/scrolly/blob/main/LICENSE)

## Installation

```bash
pip install scrolly
```

Or with [uv](https://docs.astral.sh/uv/):

```bash
uv tool install scrolly
```

## Quickstart

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

See [`examples/worked-example/`](examples/worked-example/) for a reference deck
demonstrating all supported slide types.

## License

[MIT](https://github.com/bertpl/scrolly/blob/main/LICENSE).
