revealing 1.0.8 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84a0a3762d9de3110603c7a614a68c63cd51753b24298c4c8af9c57551a5e2b9
-  data.tar.gz: 7b495015e7571389a28faffb08ffec1fbaf5e8c83ca240cbf5e9e0937cb08353
+  metadata.gz: e1256b9af11462a452d671aa0dc75c284cafd3f3c927342d6bf1818d2126c42b
+  data.tar.gz: 955ea1880102a7c4bce9c5acd3f7f694e652f7e67f351f54eec8a9856a480caa
 SHA512:
-  metadata.gz: 3842d2a06aa8dae722c81c0475096a808a44955106f00dd681da92b66ac34c1fe08bd8ad9f86dc05cdfcbd4bfef16cb2bc78f58c928726ec15fd45d05679b2aa
-  data.tar.gz: efd07443ff09568c7b5f591890a24fbb96db37df4a7977f6651ef44673f9378bba04a2939d39ab1f33abf1ac31c1294207237657330c52835475d27466c06279
+  metadata.gz: ca1068d10527644e023c66cc75841bb11936af96e74eb40f67fdd06a81d92b601ca11cd157e4aee208978230d1cc35088584325ad6d55a00d891d7b90ae91558
+  data.tar.gz: 4c6fecf3f452963e046fea2640f687a7d4a609848bb294030e9e7b6d3331b4440c7d628dee86184e51562d87fac9d8c106966e98f762ba75c96459b80dc79c6e

data/README.markdown

@@ -37,22 +37,17 @@ Unique features:
 
 # TODO
 
-1. Read desired dependencies (URLs or version numbers) from ENV vars or a YAML file (with sensible defaults coming from this project)
-1. Re-add ditaa processing, or replace with [mermaid-filter](https://github.com/raghur/mermaid-filter)
-
-Milestone: 1.1
-
-1. Allow self-hosted mathjax (copy to target)
-1. Charts using [vega-lite](https://vega.github.io/vega-lite/usage/embed.html)
-1. Add guard-livereload to the generated project
+1. BUG: Need to rebuild if a file in the headers folder changed
 1. Expose customization of
    * highlight-style
-   * slide-level
    * theme
    * slideNumber
    * history
-   * metadata (e.g. `lang=de_DE`)
 1. Provide a docker image so that we can run without installing everything
+1. Consider [mermaid-filter](https://github.com/raghur/mermaid-filter)
+1. Allow self-hosted mathjax (copy to target)
+1. Charts using [vega-lite](https://vega.github.io/vega-lite/usage/embed.html)
+1. Add guard-livereload to the generated project
 1. PDF output
 1. Make the initial set of files more meaningful (e.g. add the project name, `git config user.name` etc.)
 1. Web interface for live editing

data/lib/revealing/tasks/reveal.js.rake

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-REVEAL_JS_VERSION = '3.7.0'
+REVEAL_JS_VERSION = ENV.fetch('REVEAL_JS_VERSION', '3.7.0')
 
 desc 'reveal.js is present'
 directory REVEAL_JS_TARGET_DIR => TARGET_DIR do |target|

data/lib/revealing/tasks.rb

@@ -33,15 +33,18 @@ load "#{__dir__}/tasks/reveal.js.rake"
 
 git_dirty_file DIRTY_FILE
 
-MATH_JAX_VERSION = '2.7.5'
+MATH_JAX_VERSION = ENV.fetch('MATH_JAX_VERSION', '2.7.5')
+
+METADATA_FILE = Pathname('metadata.yml')
+file METADATA_FILE
 
 desc "Build #{TARGET_FILE}"
-file TARGET_FILE => [ TARGET_DIR, REVEAL_JS_TARGET_DIR, GPP_FILE, DIRTY_FILE] + ASSETS + RESIZED_ASSETS + HEADERS do
+file TARGET_FILE => [ TARGET_DIR, REVEAL_JS_TARGET_DIR, GPP_FILE, DIRTY_FILE, METADATA_FILE] + ASSETS + RESIZED_ASSETS + HEADERS do
   sh %(pandoc
       --to=revealjs
       --standalone
       --highlight-style zenburn
-      --slide-level=1
+      --slide-level=#{ENV.fetch('REVEAL_JS_SLIDE_LEVEL', '1')}
       --output #{TARGET_FILE}
       --variable theme=white
       --variable slideNumber=true
@@ -49,6 +52,7 @@ file TARGET_FILE => [ TARGET_DIR, REVEAL_JS_TARGET_DIR, GPP_FILE, DIRTY_FILE] +
       --variable revealjs-url=#{REVEAL_JS}
       --mathjax=https://cdnjs.cloudflare.com/ajax/libs/mathjax/#{MATH_JAX_VERSION}/MathJax.js?config=TeX-AMS_CHTML-full
       --include-in-header=#{__dir__ + '/../../templates/mathjax/config.js'}
+      "--metadata-file=#{METADATA_FILE.to_path}"
       #{HEADERS.map { |h| "--include-in-header=#{h}" }.join("\n")}
     #{GPP_FILE}
   ).split("\n").join(' ')

data/lib/revealing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Revealing
-  VERSION = '1.0.8'
+  VERSION = '1.1.0'
 end

data/templates/init/README.markdown

@@ -7,6 +7,9 @@ This is the source of New Presentation. It was generated with [`revealing`](http
 * Images are resized for the web using [`graphicsmagick`](http://www.graphicsmagick.org/)
 * `#include` and other [`gpp`](https://logological.org/gpp) features allow organizing the sources of complex presentations
 * Files in the `headers` folder are included verbatim in the HTML `<head>` section
+* MathJax is included and configured to render SVG. To use a specific version, set the environment variable `MATH_JAX_VERSION` to one of of the versions provided by [CDNJS](https://cdnjs.com/libraries/mathjax).
+* reveal.js is downloaded and unzipped at build time. Set the environment variable `REVEAL_JS_VERSION` to customize which version to use (must be one of the [released versions](https://github.com/hakimel/reveal.js/releases)). If `REVEAL_JS_DIR` is set, the files from this directory are used.
+* The environment variable `REVEAL_JS_SLIDE_LEVEL` can be set to [structure the slide show](https://pandoc.org/MANUAL.html#structuring-the-slide-show)
 
 # Setup
 

data/templates/init/metadata.yml

@@ -0,0 +1,8 @@
+lang: en_US
+keywords:
+  - presentation
+  - reveal.js
+  - ruby
+  - markdown
+  - pandoc
+  - revealing

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: revealing
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.1.0
 platform: ruby
 authors:
 - Steffen Uhlig
@@ -210,6 +210,7 @@ files:
 - templates/init/Gemfile
 - templates/init/README.markdown
 - templates/init/Rakefile
+- templates/init/metadata.yml
 - templates/init/src/index.markdown
 - templates/mathjax/config.js
 homepage: 
@@ -231,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Rake tasks to for reveal.js presentations