https://github.com/pheymann/scala-reveal-js

Build reveal.js presentations in Scala
https://github.com/pheymann/scala-reveal-js

github-pages presentation revealjs scala-rea scalajs

Last synced: 2 months ago
JSON representation

Build reveal.js presentations in Scala

• Host: GitHub
• URL: https://github.com/pheymann/scala-reveal-js
• Owner: pheymann
• License: mit
• Created: 2018-09-07T13:50:49.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-01-13T14:05:03.000Z (almost 4 years ago)
• Last Synced: 2024-10-11T08:45:52.574Z (3 months ago)
• Topics: github-pages, presentation, revealjs, scala-rea, scalajs
• Language: JavaScript
• Size: 1.65 MB
• Stars: 45
• Watchers: 6
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ScalaJS + reveal.js = ❤

This is a basic project setup to create beautiful [reveal.js](https://github.com/hakimel/reveal.js/) presentations with [ScalaJS](https://www.scala-js.org/). To use it just clone or fork this repository and simply start to write down your own slide-deck.

### How to use it

 1. Create a new SBT sub-project for your presentation (see [my-talk](https://github.com/pheymann/scala-reveal-js/blob/master/build.sbt#L30) as an example).

 2. Write down your slide-deck. For more information take a look at the [example](https://github.com/pheymann/scala-reveal-js/blob/master/my-talk/src/main/scala/MyTalk.scala) and [reveal.js](https://github.com/hakimel/reveal.js/).

 3. Compile your presentations with `sbt "project myTalk" "fastOptJS"` or if it is the final state `sbt "project myTalk" "fullOptJS"`. Just make sure you reference the right JS files in the [index.html](https://github.com/pheymann/scala-reveal-js/blob/master/my-talk/index.html) - the root of your presentation.

 

### Make it available to anybody

Best thing is, you can commit your compiled presentation and build a [Github page](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/#enabling-github-pages-to-publish-your-site-from-master-or-gh-pages) from it. Now you can share knowledge easily.

Take a look at [https://pheymann.github.io/scala-reveal-js/my-talk](https://pheymann.github.io/scala-reveal-js/my-talk) which is build with this repository. It isn't particular beautiful but it works. Just keep in mind that this is plain HTML, JS and CSS in the end and you can do with it what ever your want.

### Why?

Lately, I have to write a lot of slides for workshops and talks. I started to do that in reveal.js because it gave me a bunch of build-in features and the freedom to customize it as needed. But writing thousands of lines of HTML isn't really fun and adding headers to every slide - which also happen to change from slide to slide - is a real pain.

To overcome this problems, I integrated reveal.js into a small ScalaJS-React project to refactor common task and to somehow get headers into my slides without going insane.