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

@@ -10,3 +10,4 @@ coverage/
 **/.sass-cache/
 _site/
 dist/
+plugins-*/

_config.yml

@@ -39,5 +39,7 @@ exclude:
   - src/
   - dist/
   - node_modules/
-  - plugins/
+  - plugins-win/
+  - plugins-mac/
+  - plugins-linux/
 

docs/embedding.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Embedding ReplayWeb.page
-nav_order: 2
+nav_order: 3
 permalink: /docs/embedding
 ---
 

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"}
+
+<hr>
+
+## 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](./)

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.
 
 
 <hr>
-Next: [Sharing Links to Archived Pages](sharing.md)
+Next: [Sharing Links to Archived Pages](sharing.md)

docs/reference.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Reference
-nav_order: 3
+nav_order: 4
 has_children: true
 permalink: /docs/reference
 ---

docs/usage.md

@@ -1,13 +1,13 @@
 ---
 layout: default
 title: Usage
-nav_order: 1
+nav_order: 2
-description: 'Usage'
+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 }

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",

run-jekyll.sh

@@ -1,4 +0,0 @@
-#!/bin/bash
-export PATH=/usr/local/opt/ruby/bin:$PATH
-bundle update
-bundle exec jekyll serve --trace

src/appmain.js

@@ -190,7 +190,7 @@ class App extends LitElement
 
   <wr-coll-index>
   ${!IS_APP ? html`
-  <p slot="header" class="tagline is-size-5 has-text-centered">Explore and Replay Interactive Archived Webpages Directly in your Browser.</p>
+  <p slot="header" class="tagline is-size-5 has-text-centered">Explore and Replay Interactive Archived Webpages Directly in your Browser. <i><a target="_blank" href="./docs/examples">(See Examples)</a></i></p>
   ` : ``}
     <wr-chooser slot="header" @load-start=${this.onStartLoad}></wr-chooser>
   </wr-coll-index>
@@ -210,7 +210,7 @@ class App extends LitElement
             <p>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.</p>
             <p>The site is operated by the <a href="https://webrecorder.net/">Webrecorder Project</a></p>
-            <p>See the <a target="_blank" href="/docs">Docs</a> for more info on how it works.</p>
+            <p>See the <a target="_blank" href="./docs">Docs</a> for more info on how it works.</p>
         
             <h3>Privacy</h3>
             <p><b>No data is uploaded anywhere and no information is collected.</b></p>

src/replay.js

@@ -278,7 +278,7 @@ class Replay extends LitElement
     `}
 
     ${this.iframeUrl ? html`
-    <iframe @message="${this.onReplayMessage}" allow="autoplay 'self'; fullscreen"
+    <iframe @message="${this.onReplayMessage}" allow="autoplay 'self'; fullscreen" allowfullscreen
     src="${this.iframeUrl}"></iframe>
     ` : html`
       <nav class="panel intro-panel">

yarn.lock

@@ -291,6 +291,26 @@
     "@webassemblyjs/wast-parser" "1.9.0"
     "@xtuc/long" "4.2.2"
 
+"@webrecorder/wabac@github:https://github.com/webrecorder/wabac.js#master", "wabac@github:https://github.com/webrecorder/wabac.js#master":
+  version "2.0.1"
+  resolved "https://codeload.github.com/webrecorder/wabac.js/tar.gz/605711975257735d8de1cfde6b054c274bceb376"
+  dependencies:
+    brotli "github:foliojs/brotli.js"
+    fast-xml-parser "^3.15.1"
+    http-status-codes "^1.4.0"
+    idb "^5.0.1"
+    js-yaml "^3.13.1"
+    json-2-csv "^3.7.1"
+    jszip "^3.4.0"
+    pako "^1.0.10"
+    parse5-html-rewriting-stream "^6.0.0"
+    parse5-sax-parser "^6.0.0"
+    path-parser "^6.1.0"
+    unescape-js "^1.1.4"
+    warcio "^1.2.0"
+    wbn "^0.0.3"
+    wombat "github:webrecorder/wombat"
+
 "@xtuc/ieee754@^1.2.0":
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/@xtuc/ieee754/-/ieee754-1.2.0.tgz#eef014a3145ae477a1cbc00cd1e552336dceb790"
@@ -6086,26 +6106,6 @@ vm-browserify@^1.0.1:
   resolved "https://registry.yarnpkg.com/vm-browserify/-/vm-browserify-1.1.2.tgz#78641c488b8e6ca91a75f511e7a3b32a86e5dda0"
   integrity sha512-2ham8XPWTONajOR0ohOKOHXkm3+gaBmGut3SRuu75xLd/RRaY6vqgh8NBYYk7+RW3u5AtzPQZG8F10LHkl0lAQ==
 
-"wabac@github:https://github.com/webrecorder/wabac.js#develop":
-  version "2.0.0"
-  resolved "https://codeload.github.com/webrecorder/wabac.js/tar.gz/ebb69d2e03d1fbbbd0e1e8a6650cf6d7eb41f68b"
-  dependencies:
-    brotli "github:foliojs/brotli.js"
-    fast-xml-parser "^3.15.1"
-    http-status-codes "^1.4.0"
-    idb "^5.0.1"
-    js-yaml "^3.13.1"
-    json-2-csv "^3.7.1"
-    jszip "^3.4.0"
-    pako "^1.0.10"
-    parse5-html-rewriting-stream "^6.0.0"
-    parse5-sax-parser "^6.0.0"
-    path-parser "^6.1.0"
-    unescape-js "^1.1.4"
-    warcio "^1.2.0"
-    wbn "^0.0.3"
-    wombat "github:webrecorder/wombat"
-
 warcio@^1.2.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/warcio/-/warcio-1.2.0.tgz#2008ab3911fd0d1770fce7f2a30d919e98c8aed5"