Files

T

Henry WilkinsonandIlya Kreymer a4de740999 MKDocs conversion (#278 )

Closes #252, Closes #250

## Changes
- ReplayWeb.page uses MKDocs for documentation now!
- Requires both
[`mkdocs-macros`](https://mkdocs-macros-plugin.readthedocs.io/en/latest/)
and [`mkdocs-redirects`]
(https://github.com/mkdocs/mkdocs-redirects) plugins to be installed
- Redirects existing docs pages to their new locations under either
`/embedding` or `/user-guide`
- Unused images have been removed
- Adds new ReplayWeb.page branding!

All pages have received copy edits. All references to future (or
previously) planned features have been removed. More major content
changes of note are as follows:

### Supported Locations
- Made into a page, no longer a table. Locations are either supported or
not listed.

### Offline Use 
- Removes browser cache section, adds improved PWA install and uninstall
instructions.
- Removes navigation instructions to GitHub's releases section in favour
of a link

### Supported Formats
- Moved to the User Guide homepage
- Updated the format support

### Exploring Archives
- Example links for showcasing features have been moved to their
respective feature documentation section on this page

### Remove Usage, Examples, and Troubleshooting Pages
- Usage content is covered in the user guide index
- Troubleshooting content has been added to a question section on the
getting started page about WARC vs WACZ.
- Examples are now Featured Projects on the docs homepage!

### Build Process
- Removes Jekyll & related site assets.
- Adds new GitHub action for publishing
- Adds a python macro to dynamically load the replayweb.page version from package.json
- Relocates replayweb.page site content under /site (including docs)
- Some assets (favicon, logo) and sw.js/ui.js automatically copied into /site

---------
Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>

2024-04-07 11:07:02 -07:00

2.6 KiB

Raw Blame History

Offline Use

There are two ways of using ReplayWeb.page without continuous internet access.

Progressive Web App

ReplayWeb.page can be installed as PWA (Progressive Web App) through supported browsers. Instructions for installation vary based on the browser used to install the application.

??? question "What's a Progressive Web App?" Progressive Web Apps (PWAs) can be considered cross-platform applications. PWAs are built with the same software used to develop websites, but they also allow developers to access native desktop features to integrate better with desktop operating systems and allow for offline use!

Safari

After navigating to https://replayweb.page, open the File menu and select Add to Dock. This will add the PWA to your dock and in Launchpad.

To uninstall, long press on the app in Launchpad until the icons start to shake, then press the :bootstrap-x: icon.

Google Chrome & Microsoft Edge

After navigating to https://replayweb.page, look for the installation icon to the left of the bookmark page star in the URL bar. Pressing this icon will display a dialog with an option to install the PWA.

To uninstall on Edge, navigate to edge://apps/details/replayweb.page/ and press Uninstall

To uninstall on Chrome, open the ReplayWeb.page PWA, press the :bootstrap-three-dots-vertical: icon button in the application bar, and select Uninstall ReplayWeb.page.

Standalone Desktop App

ReplayWeb.page is also available as a standalone app!

Navigate to the latest release of ReplayWeb.page on GitHub and download the applicable file for your platform (.dmg for macOS or .exe for Windows).

The standalone app is useful for two reasons:

Flash is not supported by default in most browsers. The ReplayWeb.page App will continue to bundle Ruffle, a Flash emulator, to continue to make Flash content accessible within archived web content.
If your primary use involves viewing stored locally web archives, the ReplayWeb.page desktop app is a better option, as it provides direct access to the file system. Once loaded, ReplayWeb.page can continue to load web archives from disk without internet access. The desktop app fully replaces Webrecorder Player

When using https://replayweb.page, you may be asked to re-open a local file because a website cannot maintain persistent access to your file system.

2.6 KiB Raw Blame History