README.md in keydown-0.7.1 vs README.md in keydown-0.9.0
- old
+ new
@@ -1,11 +1,14 @@
# KeyDown
KeyDown is another 'Presentation System in a single HTML page' inspired by [Showoff](http://github.com/drnic/showoff), [Slidedown](http://github.com/nakajima/slidedown),
[HTML5 Rocks](http://studio.html5rocks.com/#Deck), with a little [Presentation Zen](http://amzn.to/8X55H2) thrown in.
+It uses the excellent [deck.js](http://imakewebthings.github.com/deck.js) and its extensions for the presentation.
+
## Usage
+ $ gem install keydown
### Generate a Template
Get started by making a sample project:
@@ -13,12 +16,14 @@
This will make:
| - my_presentation/
| - css/ - Keydown CSS and a file for you to customize
+ | - deck.js/
| - images/ - Some Keydown images, but also for you
| - js/ - Keydown JavaScript, and a file for you to customize
+ |
| - my_presentation.md
### Write your presentation in Markdown
Edit `my_presentation.md` and write your presentation as if it were going to be HTML (because it will be):
@@ -65,28 +70,18 @@
## Usage
### Presentation Title
-An optional first `H1` before a `!SLIDE` is treated as the presentation title. It will be on the configuration page and set as the HTML `<title>`.
+An optional first `H1` before a `!SLIDE` is treated as the presentation title in the HTML `<title>`.
-### Configuration Page & Navigation
-
-The first page of a Keydown presentation is a configuration page that shows the presentation title, how to navigate the presentation, and some visual effect options.
-
### Slide classes
Any text that follows `!SLIDE` will be added to the slide as CSS classes.
!SLIDE dark
-There are some built-in classes you can use:
-
-* `middle` will center all the elements on the slide
-* `bulleted` - by default, lists to not have bullets; use this class to add them back
-* `dark` - by default, slides are light with dark fonts; this swaps a slide
-
You can define your own CSS classes (see below).
### Images
Your presentation will be generated in the same directory as your Markdown file. So URI references via relative paths
@@ -113,11 +108,11 @@
}}} images/sunset.jpg::cprsize::flickr::http:://flickr.com/cprsize
### Syntax Highlighting
-Code syntax highlighting is done via [Pygments](http://pygments.org), which must be installed locally to work. All Pygments lexers are supported.
+Code syntax highlighting is done via [CodeMirror](http://codemirror.net).
Mark your code by block escaping via `@@@` or ` ``` `
For Ruby:
@@ -147,22 +142,27 @@
### Custom JavaScript.
All JavaScript files in the `js` directory will be linked in your presentation HTML file.
+### Deck.js Extensions
+
+Any extension CSS and JS will be loaded if copied into the project.
+
+
## Requirements
### For Use
* Ruby and Rubygems
- * [Pygments](http://pygments.org) is required for code syntax highlighting
* Other dependent gems will be installed
### For Development
* RSpec
* Nokogiri
+ * Other dependent gems will be installed
## Note on Patches/Pull Requests
* Fork the project.
* Make your feature addition or bug fix.
@@ -172,12 +172,13 @@
## Thanks & Attribution
Thanks to:
-* HTML5 Rocks guys for a great presentation template
+* HTML5 Rocks guys for the original great presentation template
* [@nakajima](http://twitter.com/nakajima) & [Slidedown](http://github.com/nakajima/slidedown) for some parsing
+* [Caleb](http://github.com/imakewebthings) for making deck.js & testing it with [Jasmine](http://pivotal.github.com/jasmine)
* The various Github guys for Albino, Gollum, etc.
## Copyright
-Copyright © Infews LLC. See LICENSE for details.
+Copyright © Infews LLC. See LICENSE for details.