https://github.com/stefanbirkner/jmarkdown2deckjs

Converts Markdown files to deck.js presentations.
https://github.com/stefanbirkner/jmarkdown2deckjs

Last synced: about 1 month ago
JSON representation

Converts Markdown files to deck.js presentations.

• Host: GitHub
• URL: https://github.com/stefanbirkner/jmarkdown2deckjs
• Owner: stefanbirkner
• Created: 2014-05-31T21:43:58.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-01-22T11:06:01.000Z (almost 10 years ago)
• Last Synced: 2023-07-26T22:08:35.965Z (over 1 year ago)
• Language: Java
• Size: 160 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# jmarkdown2deckjs

[![Build Status](https://travis-ci.org/stefanbirkner/jmarkdown2deckjs.svg?branch=master)](https://travis-ci.org/stefanbirkner/jmarkdown2deckjs)

jmarkdown2deckjs is a library that converts 

[Markdown](http://daringfireball.net/projects/markdown/) files to

[deck.js](http://imakewebthings.com/deck.js/) presentations.

jmarkdown2deckjs has been inspired by Ulf Börgenholz'

[markdown2deckjs](https://github.com/ulf/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

    

      com.github.stefanbirkner

      jmarkdown2deckjs

      0.1.0

    

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