<commit_before>deckdown
========

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

##Vision

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. I hope you enjoy using it. 

##How it works

Deckdown parses your markdown file into HTML, then uses the header tags as breakpoints for new slides. In this way, something like this...

```
  ##Vision
  Deckdown is for breaking out of slideware jail. I love tools like reveal.js... 

  ##How it works
  Deckdown parses your markdown file into HTML...
```

...becomes two slides in your deck. 

##Where this is headed

The goal of this project is to make something robust enough that it can be a hosted service that does fancy things like take the url of a readme file on github, and give back a bit.ly style permalink to the resulting slide deck. Conference presentations will be maintainable as a single text file. Non-devs will suddenly have access to huge amounts of content without us, the content creators, running through the hoops of slideware. Mountains will move. 

If you want to contribute, just ask. I'd love your help. <commit_msg>readme changes<commit_after>deckdown
========

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

##Usage

###From Text
Type or paste [markdown](http://website.com) 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](http://deckdown.org/deck?src=https://raw.githubusercontent.com/alanguir/deckdown/master/README.md#/).

  * Hosting on github 
  
    Commit your `.md` file to your repo, then navigate to that file on github and click 'raw' in the upper right corner. Use the url of the raw file for deckdown.
  * Hosting on Dropbox
    
    Place the markdown file in your Public folder, then right/option click to get it's public link. Use this public link with deckdown. More info on public links from [dropbox help](https://www.dropbox.com/help/16).
  * Hosting elsewhere
  
    Deckdown can take any publicly available url as an input for generating a slide deck. Links from your local filesystem that begin with `file:///` will not work. For that, just paste the contents of the file into deckdown a-la the *From Text* instructions above. 

##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. It does this with *regex*, and it splits up your file **after** converting it to html. This means html header tags `<h1> - <h6>` become the slide delimiters. 

Markdown conversion is done with [marked](http://website.com), and uses [GFM](http://website.com) by default. 

If you think you’ve run into a regex failure, please [report it](https://github.com/alanguir/deckdown/issues). 

##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:

  * Images
  
    Currently, images are included at their natural size, which can look like an error - especially for .svg or hi-res images. 
  * Overflowing Content
  
    Right now, it’s up to the markdown author to anticipate overflowing content, and to chunk accordingly. 
  * Slides of text
  
    Non-heading delimiters are currently not implemented, so each slide in deckdown *needs* a heading (or it won’t be it’s own slide).

##Contribute
Deckdown is on [github](http://github.com/alanguir/deckdown).

Created by [<NAME>](http://github.com/alanguir/) in 2014.
{'fraction_non_alphanumeric': 0.06684437153988107, 'fraction_numerical': 0.0016403526758253025, 'mean_word_length': 3.863409770687936, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, 'https://': 3, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2419460', 'n_tokens_mistral': 1340, 'n_tokens_neox': 1279, 'n_words': 749}