jmarkdown2deckjs

jmarkdown2deckjs is a library that converts Markdown files to deck.js presentations. jmarkdown2deckjs has been inspired by Ulf Börgenholz' markdown2deckjs.

File Format

Use a standard Markdown file. jmarkdown2deckjs create a new slide whenever it encounters an h1 or h2. Here is an example file with three slides.

Title Slide
===========

First Slide
-----------

content of first slide

Second Slide
------------

content of second slide

Get the Library

The library is available from Maven Central

<dependency>
  <groupId>com.github.stefanbirkner</groupId>
  <artifactId>jmarkdown2deckjs</artifactId>
  <version>0.1.0</version>
</dependency>

Create the Presentation

import com.github.stefanbirkner.jmarkdown2deckjs.*;

String markdown = readMarkdown(); //your code that reads the markdown
String deckJsHtml = new JMarkdown2DeckJs().convert(markdown);

JMarkdown2DeckJs uses relative URLs for the CSS and JavaScript files by default. You can create HTML files with different URLs by providing a configuration with a prefix for the URLs.

import com.github.stefanbirkner.jmarkdown2deckjs.*;

Configuration configuration = new Configuration("http://your.domain/");
String markdown = readMarkdown(); //your code that reads the markdown
String deckJsHtml = new JMarkdown2DeckJs(configuration).convert(markdown);