` * generated HTML is pretty-printed for easier "view source" * uses deck.js' "swiss" theme and several extensions, including `goto`, `menu`, `navigation`, `status`, `hash`, and `scale` * uses RedCarpet markdown extensions, including * tables * fenced code blocks * mostly backwards-compatible with Showoff, i.e. you can specify a `showoff.json` file on the command line * if the parameter (or 'sections' entry) starts with '# ' then it's parsed as literal markdown, not a file * code syntax highlighting using Coderay * specify language at the top of the block using either ::: or @@@ * e.g. `@@@ ruby` ## Command-Line API `deck run foo.md` * start a local Rack server (probably Sinatra) on port 4333 * http://localhost:4333/ serves the presentation built from `foo.md` * can specify multiple source files in a row * can also specify a showoff.json file to load multiple markdown files `deck build foo.md` * creates a static page `foo.html` in the current directory * unfortunately the `deck.js` source code will not be around so this won't really work yet ### Options * none yet :-) ## Command-Line API (proposed) `deck build foo.md` * create a static site * default output dir = ./public (even if foo.md is elsewhere) * copies (or inlines) deck.js source * also copies (or inlines) "img" directory if it exists ## Credits * deck.js by Caleb at * deck.rb by Alex Chaffee , with help from * Steven! Ragnarök ### See Also * [Web Slide Show GGroup](https://groups.google.com/group/webslideshow) * [Showoff](https://github.com/schacon/showoff) by Scott Chacon * [Keydown](https://github.com/infews/keydown) by Davis Frank ## Bugs and Limitations * auxiliary files (e.g. images) are interleaved in URL path space, so overlapping file names might not resolve to the right file * todo: rewrite internal links to files and serve them relative to current dir, not slide dir * H1s (which split slides) are converted to H2s for compatibility with deck.js's CSS themes * unless they're the only item on the slide, in which case they remain H1s * we use RedCarpet to process markdown, which doesn't work exactly the same as RDiscount... for example: * indented code blocks under a bullet point may need to be indented more * code blocks must be separated from the previous text by a newline * slide scaling isn't perfect; sometimes either resizing or reloading will improve the layout ## TODO * fix title tag (base it off of presentation name or something) * scale images to fit on the page * if no files are specified, use either './showoff.json' or all `.md` files under current directory * deck.json config file * config options: * show/hide theme selector * show/hide page number/nav * choose deck extensions * theme * specify which Redcarpet Markdown extensions to use * command-line tool can take a directory * first pass: globs all *.md files in it * command-line options (overriding or complementing config file options) * --output dir * --config deck.json * --port portnum * --theme themename * more slide file types * Erector - `foo/bar_bar.rb` would expect `class BarBar < Deck::Slide` in there * html * slim http://slim-lang.com/index.html * haml * tilt * option to render all JS and CSS inline, for a self-contained HTML doc * and maybe images too, base64-encoded * build and push into a gh-pages branch * build and push into a heroku app * find any lines that start with a

.(something) and turn them into

* see showoff.rb:189 * some way to build/rebuild a project that is deployable to heroku * PDF * rewrite internal links to files and serve them relative to current dir, not slide dir * custom `.css`, `.scss`, and `.js` files, which will get imported into all slides * support some more extensions https://github.com/imakewebthings/deck.js/wiki ## TODO (community) * submit theme-picker extension to deck.js * mix with keydown https://github.com/infews/keydown * gh-pages documentation site * integrate with slideshow https://github.com/geraldb/slideshow-deck.js