README.md in deckrb-0.3.0 vs README.md in deckrb-0.3.1

- old
+ new

@@ -60,10 +60,12 @@ * 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` +* there's a simple table of contents (click the [toc] link on lower left to toggle) + * this is currently very primitive and should be redone and/or integrated into deck.js ## Command-Line API `deck foo.md` @@ -77,10 +79,17 @@ --port, -p <i>: Specify alternate port (default: 4333) --build, -b: Build an HTML file instead of launching a server (WARNING: not very useful yet) --version, -v: Print version and exit --help, -h: Show this message +## Known Issues + +* If you're running Webrick, you may not be able to kill the server with Ctrl-C. This is a bug in recent versions of Webrick. + * Workaround: `gem install thin` -- if thin is installed, deck will use it instead of webrick + +Report bugs on <http://github.com/alexch/deck.rb/issues> + ## Credits * deck.js by Caleb at <http://imakewebthings.com> * deck.rb by Alex Chaffee <http://alexchaffee.com>, with help from * Steven! Ragnarök <http://nuclearsandwich.com> @@ -138,16 +147,21 @@ * 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 +* improve table of contents + * nested sections + * disappear when clicked outside of, esc pressed, etc. + * close box ## 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 +* make it a proper Rack middleware thingy and add to https://github.com/rack/rack/wiki/List-of-Middleware # License The MIT License