https://github.com/sfxcode/sbt-paradox-reveal

SBT AutoPlugin for generating reveal.js presentations with Lightbend Paradox
https://github.com/sfxcode/sbt-paradox-reveal

markdown paradox presentation reveal-js revealjs sbt sbt-plugin scala

Last synced: 18 days ago
JSON representation

SBT AutoPlugin for generating reveal.js presentations with Lightbend Paradox

• Host: GitHub
• URL: https://github.com/sfxcode/sbt-paradox-reveal
• Owner: sfxcode
• License: apache-2.0
• Created: 2019-06-22T08:55:18.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-02-24T07:41:58.000Z (over 3 years ago)
• Last Synced: 2023-08-14T07:21:02.676Z (about 1 year ago)
• Topics: markdown, paradox, presentation, reveal-js, revealjs, sbt, sbt-plugin, scala
• Language: CSS
• Homepage: https://sfxcode.github.io/sbt-paradox-reveal/
• Size: 3.17 MB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sbt-paradox-reveal

sbt AutoPlugin for generating reveal.js presentations with Lightbend

Paradox.

## Documentation

[https://sfxcode.github.io/sbt-paradox-reveal](https://sfxcode.github.io/sbt-paradox-reveal/)

## Directives

Used directives are slide, notes, quote, code  and fragments.

## Use Paradox for Reveal.js presentations

Combine the power of [Paradox](https://developer.lightbend.com/docs/paradox/current/) with the HTML presentation framework [reveal.js](https://revealjs.com/#/).

With **Paradox** for

* [Templating](https://developer.lightbend.com/docs/paradox/current/customization/templating.html)

* [Markdown file inclusion](https://developer.lightbend.com/docs/paradox/current/directives/includes.html)

* [Snippet inclusion](https://developer.lightbend.com/docs/paradox/current/directives/snippets.html)

and **Reveal.js** for

* [Slides](https://revealjs.com/#/1)

* [HTML Transtions](https://revealjs.com/#/transitions)

* [Speaker Notes](https://revealjs.com/#/20)

it is easy to create a presentation with code examples in short time.

## Usage

### Giter8 Template

g8 https://github.com/sfxcode/paradox-reveal-template.g8

Choose projectName ...

```

cd projectName

sbt

previewAuto

```

### Custom

This plugin requires sbt 1.0.0+

Install plugin in project/plugins.sbt:

```

addSbtPlugin("com.sfxcode.paradox" % "sbt-paradox-reveal" % 1.1.0)

```

Enable Plugin in your build.sbt file:

```

 enablePlugins(ParadoxRevealPlugin)

```

### Testing

Run `test` for regular unit tests.

Run `scripted` for [sbt script tests](http://www.scala-sbt.org/1.x/docs/Testing-sbt-plugins.html).

### Alternatives

Same Idea, less configuration options:

[paradox-theme-reveal.js](https://github.com/raboof/paradox-theme-reveal.js)