Ilya Kreymer
92343d59f7
Unfortunately, for proper package pathing, need to remove the `site/` subpath. This includes: - Moving everything back into root - Adding a `copy-site.sh` script to copy resources into `mkdocs/site/` before building the site with mkdocs. - Also update examples to ensure all are loading the local sw.js / ui.js - Consolidate examples in `docs/examples` - Consolidate assets under src/assets/ - Move `favicons` to root - Reformat and relint - Tests: update playwright tests to use mkdocs output, add test for embed in docs - bump to 2.0.0-beta.2
2.1 KiB
2.1 KiB
User Guide
Getting Started
- Check out Loading Archived Items to point ReplayWeb.page towards the file you wish to view.
- Once your file has been loaded, learn how to navigate the archived content!
Supported Formats
While ReplayWeb.page aims to support a variety of formats for archived web content, for best performance we recommend using WACZ files. To archive webpages to WACZ files on a per-page basis, we recommend ArchiveWeb.page. If you need to archive entire websites, check out Browsertrix.
??? question "WARC? WACZ? What's the difference?" Due to the nature of the WARC format, the entire file must be read on first use to generate an index — a list of all the pages and content available in the file used by ReplayWebpage to rebuild and display the archived content.
Inversely, WACZ files are always loaded on-demand and no indexing is required. The initial archive view should load very quickly as a result.
For users comfortable with the command line, we recommend converting WARC files to WACZ files by using the `wacz` python library, see [py-wacz on GitHub](https://github.com/webrecorder/py-wacz) for more information.
ReplayWeb.page supports the following file formats listed as "Supported". Format type is determined based on the file's extension.
| Format | Extensions | Status |
|---|---|---|
| WACZ | .wacz |
:bootstrap-check-circle-fill: Supported |
| WARC | .warc, .warc.gz |
:bootstrap-check-circle-fill: Supported |
| HAR | .har |
:bootstrap-check-circle-fill: Supported |
| WBN | .wbn |
:bootstrap-x-octagon-fill: Not Supported |
| ARC | .arc |
:bootstrap-x-octagon-fill: Not Supported |
| CDX | .cdx, .cdxj |
:bootstrap-check-circle-fill: Supported |