From 8b6c06d46e0fba7824eb4b8f5fb41cc2879b0b07 Mon Sep 17 00:00:00 2001 From: Ilya Kreymer Date: Tue, 16 Jun 2020 16:19:45 -0700 Subject: [PATCH] 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 --- .gitignore | 1 + _config.yml | 4 +++- docs/embedding.md | 2 +- docs/examples.md | 31 +++++++++++++++++++++++++++++++ docs/exploring.md | 4 ++-- docs/reference.md | 2 +- docs/usage.md | 6 +++--- package.json | 5 +++-- run-jekyll.sh | 4 ---- src/appmain.js | 4 ++-- src/replay.js | 2 +- sw.js | 2 +- ui.js | 28 ++++++++++++++-------------- yarn.lock | 40 ++++++++++++++++++++-------------------- 14 files changed, 83 insertions(+), 52 deletions(-) create mode 100644 docs/examples.md delete mode 100755 run-jekyll.sh diff --git a/.gitignore b/.gitignore index bd45a6c..a4dfdc7 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,4 @@ coverage/ **/.sass-cache/ _site/ dist/ +plugins-*/ diff --git a/_config.yml b/_config.yml index e50a8ea..591ba51 100644 --- a/_config.yml +++ b/_config.yml @@ -39,5 +39,7 @@ exclude: - src/ - dist/ - node_modules/ - - plugins/ + - plugins-win/ + - plugins-mac/ + - plugins-linux/ diff --git a/docs/embedding.md b/docs/embedding.md index 545e45a..2fdb7d4 100644 --- a/docs/embedding.md +++ b/docs/embedding.md @@ -1,7 +1,7 @@ --- layout: default title: Embedding ReplayWeb.page -nav_order: 2 +nav_order: 3 permalink: /docs/embedding --- diff --git a/docs/examples.md b/docs/examples.md new file mode 100644 index 0000000..842b582 --- /dev/null +++ b/docs/examples.md @@ -0,0 +1,31 @@ +--- +layout: default +title: Examples +nav_order: 1 +permalink: /docs/examples +--- + +## Examples + +The following examples load a small archive demonstrating the replay and browsing capabilities of ReplayWeb.page: + +- [Browse a Social Media Page](../?source=../examples/netpreserve-twitter.warc#view=replay&url=https://twitter.com/netpreserve){:target="_blank"} + +- [List All Pages](../?source=../examples/netpreserve-twitter.warc#view=pages){:target="_blank"} + +- [Search Pages by containing 'WARC'](../?source=../examples/netpreserve-twitter.warc#view=pages&query=WARC){:target="_blank"} + +- [Search for images](../?source=../examples/netpreserve-twitter.warc#view=resources&currMime=image%2F){:target="_blank"} + +
+ +## Embed Examples + +Here are some additional examples of [embedding ReplayWeb.page](./embedding), hosted separately on [https://webrecorder.net](https://webrecorder.net){:target="_blank"} + +- [Embed Example 1](https://webrecorder.net/embed-demo-1.html){:target="_blank"} + +- [Embed Example 2](https://webrecorder.net/embed-demo-2.html){:target="_blank"} + + +Next: [Using ReplayWeb.page](./) diff --git a/docs/exploring.md b/docs/exploring.md index eea97a4..42eb284 100644 --- a/docs/exploring.md +++ b/docs/exploring.md @@ -2,7 +2,7 @@ layout: default title: Exploring Web Archives nav_order: 2 -parent: Usage +parent: About permalink: /docs/exploring --- @@ -63,4 +63,4 @@ ReplayWeb.page will soon load existing extracted full-text data as well.
-Next: [Sharing Links to Archived Pages](sharing.md) \ No newline at end of file +Next: [Sharing Links to Archived Pages](sharing.md) diff --git a/docs/reference.md b/docs/reference.md index 234838c..5435b53 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -1,7 +1,7 @@ --- layout: default title: Reference -nav_order: 3 +nav_order: 4 has_children: true permalink: /docs/reference --- diff --git a/docs/usage.md b/docs/usage.md index e1c7b7e..5f22e1d 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -1,13 +1,13 @@ --- layout: default title: Usage -nav_order: 1 -description: 'Usage' +nav_order: 2 +description: About ReplayWeb.page has_children: true permalink: /docs/index.html --- -# ReplayWeb.Page +# Using ReplayWeb.Page ## Serverless / Client-Side Web Archive Replay {: .fs-6 .fw-300 } diff --git a/package.json b/package.json index 498cfbb..e01269e 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "replaywebpage", "productName": "ReplayWeb.page", - "version": "1.0.0", + "version": "1.0.1-alpha.0", "description": "Serverless Web Archive Replay", "repository": "https://github.com/webrecorder/replayweb.page", "homepage": "https://replayweb.page/", @@ -9,6 +9,7 @@ "license": "AGPL-3.0-or-later", "dependencies": { "@fortawesome/fontawesome-free": "^5.13.0", + "@webrecorder/wabac": "github:https://github.com/webrecorder/wabac.js#master", "bulma": "^0.8.2", "flexsearch": "^0.6.32", "keyword-mark-element": "^0.1.2", @@ -17,7 +18,7 @@ "mime-types": "^2.1.27", "pretty-bytes": "^5.3.0", "register-service-worker": "^1.7.1", - "wabac": "github:https://github.com/webrecorder/wabac.js#develop" + "wabac": "github:https://github.com/webrecorder/wabac.js#master" }, "devDependencies": { "css-loader": "^3.5.3", diff --git a/run-jekyll.sh b/run-jekyll.sh deleted file mode 100755 index f05fc2d..0000000 --- a/run-jekyll.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/bash -export PATH=/usr/local/opt/ruby/bin:$PATH -bundle update -bundle exec jekyll serve --trace diff --git a/src/appmain.js b/src/appmain.js index 10968c1..605c626 100644 --- a/src/appmain.js +++ b/src/appmain.js @@ -190,7 +190,7 @@ class App extends LitElement ${!IS_APP ? html` -

Explore and Replay Interactive Archived Webpages Directly in your Browser.

+

Explore and Replay Interactive Archived Webpages Directly in your Browser. (See Examples)

` : ``} @@ -210,7 +210,7 @@ class App extends LitElement

This site is a static browser-based application that loads web archive files provided by the user and renders them for replay in the browser.

The site is operated by the Webrecorder Project

-

See the Docs for more info on how it works.

+

See the Docs for more info on how it works.

Privacy

No data is uploaded anywhere and no information is collected.

diff --git a/src/replay.js b/src/replay.js index 2bc01dd..912c818 100644 --- a/src/replay.js +++ b/src/replay.js @@ -278,7 +278,7 @@ class Replay extends LitElement `} ${this.iframeUrl ? html` - ` : html`