README.md in deckrb-0.2.0 vs README.md in deckrb-0.2.1
- old
+ new
@@ -1,9 +1,10 @@
# deck.rb
*slides in markdown, using deck.js*
+Home: <http://github.com/alexch/deck.rb>
## Installation
gem install deckrb
@@ -26,11 +27,11 @@
# Dinner
> "To eat is to live." -Anon.
then run this:
- deck meals.md
+ deck run 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")
@@ -41,26 +42,25 @@
[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:
* clean(ish) page skeleton allows you to focus on your slides, not the HTML/CSS infrastructure
* multiple slide source formats, including
- * Markdown
-* presentations can comprise several source files
+ * [Markdown](http://daringfireball.net/projects/markdown/)
+ * should be easy to add other formats
+* presentations can span several source files, and can be assembled piecemeal
* source files look good as source, built HTML, preview HTML, or as a deck doc
- * each H1 designates the beginning of a new slide
- * explicit `!SLIDE` or `<!SLIDE>` directives can split slides too
- * slide directives look like comments when rendered into HTML (e.g. as <!SLIDE>)
+ * each H1 (single hash) designates the beginning of a new slide
+ * explicit `!SLIDE` or `<!SLIDE>` directives can split slides too -- use `<!SLIDE>` so they look like comments when rendered into normal HTML
+ * links to image files are resolved relative to the source file -- no more broken images in markdown previews, and no need to put all your images in a separate directory!
+ * add CSS classes to slides inside the slide directive - - e.g. `<!SLIDE center>` gives `<section class="slide center">`
* generated HTML is pretty-printed for easier "view source"
- * links to auxiliary files (e.g. `img src`) are resolved relative to the source file -- no more broken images in markdown previews!
- * add CSS classes to slides inside the slide directive -- e.g. `<!SLIDE center>` gives `<section class="slide center">`
-* uses deck.js` "swiss" theme and several extensions, including `goto`, `menu`, `navigation`, `status`, `hash`, and `scale`
+* uses deck.js' "swiss" theme and several extensions, including `goto`, `menu`, `navigation`, `status`, `hash`, and `scale`
* uses RedCarpet markdown extensions, including
* tables <http://michelf.com/projects/php-markdown/extra/#table>
* fenced code blocks <http://michelf.com/projects/php-markdown/extra/#fenced-code-blocks>
-* mostly compatible with Showoff
- * specifying 'showoff.json' on the command line loads all slides in its 'sections' section
-* if the parameter starts with '# ' then it's parsed as literal markdown, not a file
+* 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
@@ -96,28 +96,29 @@
* deck.rb by Alex Chaffee <http://alexchaffee.com>, with help from
* Steven! Ragnarök <http://nuclearsandwich.com>
### See Also
-* showoff by Scott Chacon
-* keydown by Davis Frank
+* [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
@@ -144,14 +145,13 @@
* find any lines that start with a <p>.(something) and turn them into <p class="something">
* 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
## TODO (community)
* submit theme-picker extension to deck.js
-* add to deck.js wiki https://github.com/imakewebthings/deck.js/wiki
-* announce on https://groups.google.com/forum/#!forum/webslideshow
* mix with keydown https://github.com/infews/keydown
* gh-pages documentation site
* integrate with slideshow https://github.com/geraldb/slideshow-deck.js