README.md in slidedown-0.1.1 vs README.md in slidedown-0.2.0
- old
+ new
@@ -2,12 +2,11 @@
Generate slides with Markdown
## Usage
-Write your talk. Currently, the syntax highlight lexer defaults to Ruby.
-Adding support for specifying languages is in the TODOs.
+Write your talk.
!SLIDE
# This is my talk
@@ -33,40 +32,53 @@
$ slidedown my-talk.md
### Custom Styles
-To add custom styles to your slides, just create stylesheets in the same directory as your presentation's markdown file:
+To add custom styles to your slides, just create stylesheets in the same directory as your presentation markdown file:
| - presentation-directory
| - slides.md
| - styles.css
The additional styles will be added to your generated slides.
+## Navigation
+
+Give your presentation!
+
+* left, right arrows to navigate through slides
+* esc to go home
+
## Syntax Highlighting
-slidedown syntax highlighting works just like Lighthouse's:
+For Ruby:
@@@ ruby
- def foo
- :bar
- end
+ def foo
+ :bar
+ end
@@@
-Or for JavaScript
+For Javascript
@@@ js
- function foo() {
- return 'bar';
- }
+ function foo() {
+ return 'bar';
+ }
@@@
+For ERb:
+
+ @@@ rhtml
+ <%= @post.created_at.to_s(:fancy) %>
+ @@@
+
### Requirements
-* RDiscount
* Nokogiri
+* makers-mark
* pygments (for syntax highlighting)
## Todo
* Other means of navigation besides left/right keys
@@ -98,6 +110,6 @@
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file
+OTHER DEALINGS IN THE SOFTWARE.