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
40 lines
2.5 KiB
Markdown
40 lines
2.5 KiB
Markdown
---
|
|
hide:
|
|
- navigation
|
|
- toc
|
|
---
|
|
|
|
# Home
|
|
|
|
Welcome to the ReplayWeb.page documentation! These docs contain the following sections:
|
|
|
|
- [User Guide](user-guide/index.md) — Introduction and reference for using ReplayWeb.page to view archived web content.
|
|
- [Embedding Docs](embedding/index.md) — Information on integrating and embedding ReplayWeb.page as a web archive viewer into existing web sites.
|
|
|
|
## What is ReplayWeb.page?
|
|
[ReplayWeb.page](https://replayweb.page) is an open-source, browser-based viewer that loads and renders static web archive files. It functions as a serverless (client side) replay tool that _doesn't_ require a server to coordinate what archived content should be retrieved from a large central repository. It allows web archives to be hosted on any regular web server and viewed in any modern browser.
|
|
|
|
### Key Features
|
|
|
|
- High-fidelity replay of archived items in several formats.
|
|
- Page search and URL search.
|
|
- Full text search support for archived items that include extracted text.
|
|
- On-demand, incremental loading of large files.
|
|
- Several options for fully-functional offline usage, including a standalone desktop app with Flash support.
|
|
- Support for embedding archived items directly into your website!
|
|
|
|
### Archives, Repositories, and Other Projects Using ReplayWeb.page
|
|
|
|
ReplayWeb.page allows web archives seamlessly integrate into existing web sites, be it repositories, collections, or other archiving services.
|
|
|
|
Below are a few of the integrations we know of that use ReplayWeb.page:
|
|
|
|
- [Perma.cc](https://archive.blogs.harvard.edu/perma/2022/08/17/new-playback-software-improves-fidelity-of-your-perma-links/) — Web archiving service offered by Harvard's Library Innovation Lab.
|
|
- [GhostArchive](https://ghostarchive.org/) — Free Web Archiving Service
|
|
- [The Feminist Institute](https://www.thefeministinstitute.org/digital-archive/archived-websites) — Websites archived to document and celebrate feminist contributions to culture.
|
|
- [CineFiles](https://cinefiles.bampfa.berkeley.edu/?f%5Bdoctype_s%5D%5B%5D=web+archive) — Film-related web archive ephemera collected by the UC Berkeley Art Museum and Pacific Film Archive.
|
|
- [Stanford Digital Publication Web Archives](https://archive.supdigital.org/) — Archives of Stanford University Press Digital Publications.
|
|
- [ysdn.info](https://ysdn.info/) — Final year grad show websites from the now defunct York / Sheridan design program.
|
|
|
|
If you know of any additional sites that you'd like us to include here, let us know by writing to _info_ [at] _webrecorder.net_
|