README.md in deckrb-0.3.1 vs README.md in deckrb-0.4.0
- old
+ new
@@ -24,21 +24,22 @@
<!SLIDE>
![a picture of my lunch](ham-sandwich.jpg)
# Dinner
> "To eat is to live." -Anon.
+ <!VIDEO u1zgFlCw8Aw>
then run this:
deck meals.md
and you'll get a web server running on `http://localhost:4333` serving up a slide presentation with four slides:
* One titled "Breakfast" with three bullet points
* One titled "Lunch" with three H2 headers ("Lunch", "Ham Sandwich", and "Caesar Salad")
* One with no headers, just a picture (stored in the same directory as `meals.md`)
-* One titled "Dinner" with a blockquote
+* One titled "Dinner" with a blockquote and an embedded youtube video player
## Details
[deck.js](http://imakewebthings.github.com/deck.js) is a JavaScript library for building slide presentations using HTML 5. [deck.rb](http://github.com/alexch/deck.rb) builds on top of deck.js, adding some features:
@@ -79,14 +80,22 @@
--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
+## Known Issues (Bugs and Limitations)
-* 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.
+* If you're running Webrick, you may not be able to kill the server with Ctrl-C. This is apparently due to a bug in recent versions of Webrick.
* Workaround: `gem install thin` -- if thin is installed, deck will use it instead of webrick
+* 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
Report bugs on <http://github.com/alexch/deck.rb/issues>
## Credits
@@ -98,21 +107,10 @@
* [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
@@ -151,9 +149,16 @@
* 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
+* requests from Christopher Gandrud <http://christophergandrud.blogspot.com/2012/05/aspirational-useful-deckrb-with.html>
+ * There really aren’t title slides.
+ * The slideshow opens as a locally hosted webserver, and the command to build a stand alone HTML presentation doesn’t seem to work that well (hence no example included with this post).
+ * It only allows you to use the Swiss template.
+ * I couldn’t figure out how to easily get MathJax support to display equations.
+
+
## TODO (community)
* submit theme-picker extension to deck.js
* mix with keydown https://github.com/infews/keydown