Introduction

This format combines JSON with the Zip compressed archive format.

Stencila supports JSON+Zip as a portable compressed alternative to JSON for storing large documents. The JSON content inside the archive can be inspected with standard Zip tools, making it more portable than CBOR+Zstd, though CBOR+Zstd may achieve better compression ratios.

Usage

Use the .json.zip file extension, or the --to jsonzip or --from jsonzip options, when converting to/from JSON+Zip e.g.

stencila convert doc.smd doc.json.zip

Implementation

Stencila supports lossless, bi-directional conversion between Stencila documents and JSON+Zip powered by the Rust crates serde_json and zip.

Limitations

Compression adds overhead for small documents where the Zip metadata may negate size savings.

The archive contains a single JSON file. It does not bundle external assets such as images.