Skip to content

crystal-lang/crystal-presents

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Creative Commons License

Crystal Presentations

This is a crystal playground that uses Reveal.js to build awesome presentations capable of running crystal code.

The slides are splitted across multiple files.

Writing slides

Fork/clone and write your own slides in ./slides. Use the normal git branching so you can update the slide engine in the future. This will also promote sharing the slides (if you wish).

Create .html and .md files for each slide in ./slides folder. Slides will appear in alphabetical order.

Numbering them as:

  1. 010-
  2. 020-

will allow you to easy put slides in between ;-). Use ./bin/add [Slide title] to create this files automatically.

In a .md file you can use ````playground` to include a interactive playground snippet.

Compile slides

$ ./bin/build-slides
$ crystal play

Open http://localhost:8080/workbook/playground/slides.

Live reload

Start a crystal playground in a terminal and run ./bin/watch. It will look for changes in ./slides compile them and reload the current chrome tab.

$ crystal play
$ ./bin/watch

./bin/watch Requirements

PDF Export

Compile the slides with ./bin/build-slides --no-playground. This will embed the playground snippets as plain source code, better for printing.

Open http://localhost:8080/workbook/playground/slides?print-pdf. Read more in Reveal.js - PDF Export section.