Merge pull request #90 from tomeshnet/remark-module-1

The Remark-able Overhaul!

Author: Shrinks99

README.md

@@ -52,9 +52,7 @@ This course can be facilitated in an environment without internet access. Partic
 
 ## Workshop Materials
 
-Class materials are written as [Markdown](https://en.wikipedia.org/wiki/Markdown) files and presentation slides are created as a Markdown-based [GitBook](https://www.gitbook.com). All generated assets are hosted on [GitHub Pages](https://tomeshnet.github.io/p2p-internet-workshop/) and packaged as a downloadable archive on [GitHub Releases](https://github.com/tomeshnet/p2p-internet-workshop/releases/latest).
-
-When facilitating the workshop in an offline environment, you can run `gitbook serve` from a `presentation` directory to serve the slides on `http://localhost:4000`.
+Class materials are written as [Markdown](https://en.wikipedia.org/wiki/Markdown) files and presentation slides are created as Markdown-based [Remark slides](https://github.com/gnab/remark). All generated assets are hosted on [GitHub Pages](https://tomeshnet.github.io/p2p-internet-workshop/) and packaged as a downloadable archive on [GitHub Releases](https://github.com/tomeshnet/p2p-internet-workshop/releases/latest).
 
 If you want to generate course assets yourself, simply run `./install-dependencies.sh` and `./build.sh`. You will find the generated assets in the `output` folder. The `./package.sh` script is used to zip up the generated assets into downloadable archives and to create the course website.
 
@@ -92,7 +90,7 @@ Other accessories:
 
 The first version of this syllabus is created by [Toronto Mesh](https://tomesh.net) contributors: [@benhylau](https://github.com/benhylau), [@darkdrgn2k](https://github.com/darkdrgn2k), [@dcwalk](https://github.com/dcwalk), [@uditvira](https://github.com/uditvira), [@Shrinks99](https://github.com/Shrinks99), and [@Pedro-on-a-bike](https://github.com/Pedro-on-a-bike). While most of the material is created new, the course also incorporates many prior works listed [here](https://tomeshnet.github.io/p2p-internet-workshop/articles/general/general-extra-resources.pdf), or otherwise referenced in their individual course modules.
 
-Hands-on activities rely on software from many projects: [mesh-orange](https://github.com/tomeshnet/mesh-orange), [mesh-router-builder](https://github.com/benhylau/mesh-router-builder), [mesh-workshop](https://github.com/benhylau/mesh-workshop/), [steamlink](https://github.com/steamlink), [cjdns](https://github.com/cjdelisle/cjdns/), [Yggdrasil](https://yggdrasil-network.github.io/about.html), [IPFS](https://ipfs.io/), [Secure Scuttlebutt](https://github.com/ssbc/). Course material generation uses [markdown-pdf](https://github.com/alanshaw/markdown-pdf) and [gitbook-cli](https://github.com/GitbookIO/gitbook-cli). The course website is built with [Jekyll](https://jekyllrb.com/), and the theme is from [Mozilla's Open Leadership Training Series](https://github.com/mozilla/open-leadership-training-series). Icons from [Font Awesome](http://fontawesome.io/) and [Jake Ingman](https://thenounproject.com/search/?q=mesh&i=74809) are used.
+Hands-on activities rely on software from many projects: [mesh-orange](https://github.com/tomeshnet/mesh-orange), [mesh-router-builder](https://github.com/benhylau/mesh-router-builder), [mesh-workshop](https://github.com/benhylau/mesh-workshop/), [steamlink](https://github.com/steamlink), [cjdns](https://github.com/cjdelisle/cjdns/), [Yggdrasil](https://yggdrasil-network.github.io/about.html), [IPFS](https://ipfs.io/), [Secure Scuttlebutt](https://github.com/ssbc/). Course material generation uses [markdown-pdf](https://github.com/alanshaw/markdown-pdf) and [decktape](https://github.com/astefanutti/decktape). The course website is built with [Jekyll](https://jekyllrb.com/), and the theme is from [Mozilla's Open Leadership Training Series](https://github.com/mozilla/open-leadership-training-series). Icons from [Font Awesome](http://fontawesome.io/) and [Jake Ingman](https://thenounproject.com/search/?q=mesh&i=74809) are used.
 
 ## License
 

build.sh

@@ -8,10 +8,14 @@ mkdir output
 css="pdf.css"
 echo "Using CSS styles from $css"
 
+# Define starting directory
+base_dir="$(pwd)"
+
+# Create folder for general assets
+mkdir output/general
+
 # Generate general assets
 for doc in general/*.md; do
-    # Create folder for general assets
-    mkdir output/general
 
     # Generate assets as .pdf
     if [ -f $doc ]; then
@@ -21,10 +25,13 @@ for doc in general/*.md; do
     fi
 done
 
+# Copy technical files used by Remark
+cp -r "slide-files" "output/"
+
 # Go through each module
 for mod in module-*; do
     # Create folder for module
-    mkdir "$mod"
+    mkdir "output/$mod"
 
     # Generate lesson plan .pdf
     doc="$mod/README.md"
@@ -34,21 +41,29 @@ for mod in module-*; do
         markdown-pdf "$doc" --out "$out" --cwd "$mod" --css-path "$css"
     fi
 
-    # Generate worksheets as .pdf
-    mkdir "output/$mod/worksheet"
-    for doc in $mod/worksheet/*.md; do
+    # Generate handouts as .pdf
+    mkdir "output/$mod/handouts"
+    for doc in $mod/handouts/*.md; do
         if [ -f $doc ]; then
-            out="output/$mod/worksheet/$(echo "$doc" | sed 's|/|-|g' | sed 's|.md|.pdf|')"
-            echo "Generating worksheet from $doc to $out"
-            markdown-pdf "$doc" --out "$out" --cwd "$mod/worksheet" --css-path "$css"
+            out="output/$mod/handouts/$(echo "$doc" | sed 's|/|-|g' | sed 's|.md|.pdf|')"
+            echo "Generating handouts from $doc to $out"
+            markdown-pdf "$doc" --out "$out" --cwd "$mod/handouts" --css-path "$css"
         fi
     done
 
-    # Generate presentation GitBook
-    book="$mod/presentation"
-    if [ -d $book ]; then
-        out="output/$mod/presentation"
-        echo "Generating presentation from $book to $out"
-        gitbook build "$book" "$out"
-    fi
+    # Copy Remark presentation and generate .pdf copy with DeckTape
+    doc="presentation.html"
+    cd $mod
+    if [ -f $doc ]; then
+        # Generate .pdf
+        out="../output/$mod/handouts/$mod-presentation.pdf"
+        echo "Generating presentation from $mod/$doc to $out"
+        decktape remark "$doc" "$out" --chrome-arg=--allow-file-access-from-files
+
+        # Copy Remark presentation
+        cp -r "slide-images" "../output/$mod/"
+        cp "$doc" "../output/$mod/"
+     fi
+     cd $base_dir
+
 done

install-dependencies.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
-# For generating course materials in PDF
+# For rendering course materials to .pdf
 npm install -g markdown-pdf
 
-# For generating presentation slides with GitBook
-npm install -g gitbook-cli
+# For converting Remark presentations to .pdf
+npm install -g decktape
 
 # For generating course website with Jekyll
 gem install bundler