carimura / slides

Slides for various talks I give

Slides

Slides for various talks I give and have given. They are written with the awesome Asciidoctor and visualized with reveal.js. Thanks to GitHub Pages you can see them on slides.nipafx.dev.

• setup
  • repository structure
  • Asciidoctor
• editing
  • slides
  • themes

Setup

Repository Structure

An amalgam of submodules and worktrees...

Branch master

• _asciidoctor-reveal.js (submodule ~> CodeFX-org/asciidoctor-reveal.js; nipa-talks)
• _shared (contains snippets that are shared among presentations)
• _shared-images (contains images that are shared among presentations)
• a subdirectory for each presentation, with all required files except shared ones
• meta-information (LICENSE, README, ...)

After checkout, the submodule needs to be initialized and the gh-pages branch should be added as a worktree to master:

git submodule update
git worktree add _slides gh-pages

Then run bundle install to install all the right Ruby Gems as described in the Asciidoctor-Reveal.js setup guide.

Branch gh-pages

• _highlight.js (downloaded from highlightjs.org)
• images (folder for landing page)
• _reveal.js (submodule ~> CodeFX-org/reveal.js; nipa-talks)
• _template (a template for presentations)
• landing page (favicon, index.html, CNAME for GH Pages)

After checkout, the submodule needs to be initialized:

git submodule update

Asciidoctor

After installing bundler, run bundle install to install all required Ruby gems.

Editing...

Slides

To generate a slide deck (for example java-next), you need to run this in the repository's root:

bundle exec asciidoctor-revealjs java-next/_presentation.adoc -o _slides/java-next/index.html

If you want to automate that, you can run bundle exec guard in the same folder. It detects file system changes and calls the same command for the edited slide deck. (It does not use the asciidoctor gem directly because that does not resolve include-directives - at least not on my machine.)

Themes

Finally, to edit the theme do a full setup for reveal.js in _slides/_reveal.js. Here, grunt serve will automatically pick up changes in _slides/_reveal.js/css/theme/source and create the CSS files in the correct location.