13protons / deckdown

Write markdown, get a slide deck. No BS.
http://deckdown.org
MIT License
79 stars 9 forks source link

deckdown

Deckdown

Write markdown, get a slide deck. No BS. Or JS. Or HTML.

Try it at http://deckdown.org

Usage

From Text

Type or paste markdown into the form above, and hit 'create deck'. Valid markdown will be parsed into a deck for you to enjoy. Deckdown currently doesn't save the markdown text that you submit to it so this is a one time, unique thing.

From A File

Tell deckdown the url of your raw .md file by passing it as the src parameter, like this:

http://deckdown.org/deck?src=path/to/yourdeck.md

For example, here's a slideshow version of the deckdown readme.

Why use it?

Deckdown is for breaking out of slideware jail. Traditional slideware is hard to proofread, and tweaking text size and alignment on large decks feels like a waste of time. I love reveal.js (it's used in this project), but the process of writing markup around my content in order to present it feels like a new flavor of the old slideware bloat.

Deckdown changes all that by taking the contents of a single text file and turning it into a completely acceptable and usable slide deck.

Presentations that include code examples may never be the same. I hope you enjoy using deckdown.

How it works

Deckdown breaks your markdown file into slides based on headers and horizontal rules. It does this with regex, and it splits up your file after converting it to html. This means html header tags <h1> - <h6> and <hr> become the slide delimiters.

When writing your markdown:

This Creates a New Slide
========================

#So does this

***
(That one does too)

Markdown conversion is done with kramed, and uses GFM by default.

Known issues

Deckdown is still in an early experimental state. Feel free to use it for your presentations if you wish, just know that sailing is not yet a smooth as it could be. Here are some of the bigger issues keeping deckdown from taking the world by storm:

Contribute

Deckdown is on github.

Created 2014 by Alan Languirand. MIT license.