README.md in slide_hero-0.0.4 vs README.md in slide_hero-0.0.5
- old
+ new
@@ -50,11 +50,10 @@
**presentation**
```ruby
presentation "My Presentation" do
-
end
```
`#presentation` indicates the beginning of a presentation. You can have one of these per file. The String passed is used as the title for the presentation.
@@ -85,10 +84,23 @@
slide "A slide", transition: :slide do
#…
end
end
```
+
+`#slide` can have a background color applied. This will only add the color to
+this one slide. Any css color will work.
+
+```ruby
+presentation "My Presentation" do
+ slide "A slide", background_color: 'blue' do
+ #…
+ end
+end
+```
+
+
**defaults**
```ruby
presentation "My Presentation" do
defaults headline_size: :medium, transition: :fade
@@ -102,11 +114,41 @@
end
end
```
You can set slide defaults for `headline_size` or `transition` by using `#defaults`. A slide default applies to all slides unless an individual slide overrides it.
+The theme is set to Default. to change this, use the `set_theme` method in the
+presentation block.
+``` ruby
+presentation "My Presentation" do
+ set_theme 'solarized'
+end
+```
+
+Valid theme options are: default, sky, beige, simple, serif, night, moon, solarized
+
+**plugins**
+
+You can activate revealjs plugins by passing a symbol array to the
+`set_plugins` method.
+
+``` ruby
+presentation "My Presentation" do
+ set_plugins :class_list, :remote, :leap
+end
+```
+
+Currently supported plugins are `:class_list`, `:markdown`, `:highlight`, `:zoom`,
+`:notes`, `:remote`, and `:leap`.
+
+`:class_list`, `:hightlight`, and `:notes` are used if `set_plugins` is
+not called.
+
+See Reveal.js [documentation](https://github.com/hakimel/reveal.js/#dependencies) for more info on these plugins.
+
+
**points**
```ruby
presentation "My Presentation" do
slide "A slide" do
@@ -144,9 +186,12 @@
end
slide "Slide 2" do
list(:ordered) do
point "I should go first"
point "I'm ok going second"
+ list do
+ point "I'm in a nested list"
+ end
end
end
end
```