Commit Graph
11 Commits
Author SHA1 Message Date
Ilya KreymerandHenry Wilkinson 858f9d61bb Convert URL encoded images to inline SVGs with fa-icon (#303)
Avoid data: URL loading and just inject SVG inline directly for logo, receipt and loader
Additional favicon path fixes

---------
Co-authored-by: Henry Wilkinson <henry@wilkinson.graphics>
2024-04-09 15:00:08 -07:00
Henry WilkinsonandIlya Kreymer 88ca04e52e Add example links to exploring section (#298)
- Moves example WARC files to /site/examples
- Adds example link for full text search
- Adds example link for searching resources
- Updates example docs link on the app homepage, sends to the project
showcase section
- Link fix
- .gitignore update
---------

Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
2024-04-07 14:48:58 -07:00
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
sua yoo 22313c5bb1 Build Webpack in Pages workflow (#222) 2023-09-05 17:26:14 -07:00
av8ta 9e75593429 Add pattern to file chooser for ssb urls (#103)
* add pattern to chooser to match ssb:// urls
* also gitignore ipfs bundle
2022-06-15 11:42:50 -07:00
Ilya Kreymer 8b6c06d46e docs tweak: add examples page, link to examples from home page
update to latest sw, ensure OPTIONS is not indexed as mentioned in webrecorder/pywb#569
ensure plugins-* directories are excluded from git and from jekyll
bump version to 1.0.1-alpha.0
2020-06-16 16:29:52 -07:00
Ilya Kreymer 220d14aea3 jekyll: move jekyll back to root, but simpler setup, exclude via _config.yml
app: bundle jekyll docs into app, add 'yarn run docs' to build
ui: add back/forward arrows for app only, adjust responsiveness for app, add IS_APP flag injected via preload
ui: add animated logo, friendly message on empty replay frame
app: improve serve logic:
- serve static files from static root
- serve replay from http localhost instead to avoid proxying https for remote requests
- serve local lookup from http prefix also
- catch any fallthrough from replay as 404
- add timestamp to response channels to ensure uniqness
2020-05-21 18:49:26 -07:00
Ilya Kreymer da1e5c03df reorg dir structure:
- keep shared and electron build at root
- move static files for replayweb.page and Jekyll config to docs/
- move Jekyll markdown to docs/docs/
2020-05-20 17:28:03 -07:00
Ilya Kreymer 1a2f2c00a2 add electron build!
- use webpack to build electron-main and electron-preload
- intercept 'https' protocol to run on 'https://replayweb.page' in app
- serve local files from 'https://files.replayweb.page'
- support flash in with service worker replay: catch any fallthrough urls and load via intercept with render process callback
- add icons for electron build
2020-05-19 22:49:08 -07:00
Ilya Kreymer ed456fbb5f docs: add jekyll just-the-docs docs, initial pass 2020-05-03 22:21:07 -07:00
Ilya Kreymer e023726fd2 split off from wabac.js:
- add pageembeds.js for now
- new webpack build, use /sw.js in prod, /dist/sw.js in dev to work with webpack-dev-server single directory
- add wombat dependency and webpack build
2020-05-02 11:27:48 -07:00