jmarkdown2deckjs

Converts Markdown files to deck.js presentations.

License

License

GroupId

GroupId

com.github.stefanbirkner
ArtifactId

ArtifactId

jmarkdown2deckjs
Last Version

Last Version

0.1.0
Release Date

Release Date

Type

Type

jar
Description

Description

jmarkdown2deckjs
Converts Markdown files to deck.js presentations.
Project URL

Project URL

https://github.com/stefanbirkner/jmarkdown2deckjs
Source Code Management

Source Code Management

https://github.com/stefanbirkner/jmarkdown2deckjs/

Download jmarkdown2deckjs

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.stefanbirkner/jmarkdown2deckjs/ -->
<dependency>
    <groupId>com.github.stefanbirkner</groupId>
    <artifactId>jmarkdown2deckjs</artifactId>
    <version>0.1.0</version>
</dependency>
// https://jarcasting.com/artifacts/com.github.stefanbirkner/jmarkdown2deckjs/
implementation 'com.github.stefanbirkner:jmarkdown2deckjs:0.1.0'
// https://jarcasting.com/artifacts/com.github.stefanbirkner/jmarkdown2deckjs/
implementation ("com.github.stefanbirkner:jmarkdown2deckjs:0.1.0")
'com.github.stefanbirkner:jmarkdown2deckjs:jar:0.1.0'
<dependency org="com.github.stefanbirkner" name="jmarkdown2deckjs" rev="0.1.0">
  <artifact name="jmarkdown2deckjs" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.github.stefanbirkner', module='jmarkdown2deckjs', version='0.1.0')
)
libraryDependencies += "com.github.stefanbirkner" % "jmarkdown2deckjs" % "0.1.0"
[com.github.stefanbirkner/jmarkdown2deckjs "0.1.0"]

Dependencies

compile (2)

Group / Artifact Type Version
commons-io : commons-io jar [2.0,3.0)
com.github.rjeschke : txtmark jar [0.11,)

test (3)

Group / Artifact Type Version
junit : junit jar [4.11]
org.hamcrest : hamcrest-core jar [1.3]
org.hamcrest : hamcrest-library jar [1.3]

Project Modules

There are no modules declared in this project.

jmarkdown2deckjs

Build Status

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);

Versions

Version
0.1.0