reveal-ck 0.1.8 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +8 -8
- data/README.md +3 -11
- data/bin/reveal-ck +38 -3
- data/lib/reveal-ck.rb +2 -0
- data/lib/reveal-ck/markdown.rb +2 -0
- data/lib/reveal-ck/markdown/slide_markdown.rb +22 -0
- data/lib/reveal-ck/markdown/slide_markdown_template.rb +22 -0
- data/lib/reveal-ck/tilt/config.rb +2 -0
- data/lib/reveal-ck/version.rb +1 -1
- data/reveal.js/Gruntfile.js +4 -3
- data/reveal.js/README.md +135 -13
- data/reveal.js/css/print/pdf.css +1 -1
- data/reveal.js/css/reveal.css +242 -15
- data/reveal.js/css/reveal.min.css +1 -1
- data/reveal.js/css/theme/beige.css +7 -1
- data/reveal.js/css/theme/blood.css +175 -0
- data/reveal.js/css/theme/default.css +7 -1
- data/reveal.js/css/theme/moon.css +7 -1
- data/reveal.js/css/theme/night.css +7 -1
- data/reveal.js/css/theme/serif.css +7 -1
- data/reveal.js/css/theme/simple.css +7 -1
- data/reveal.js/css/theme/sky.css +7 -1
- data/reveal.js/css/theme/solarized.css +7 -1
- data/reveal.js/css/theme/source/blood.scss +91 -0
- data/reveal.js/css/theme/template/theme.scss +8 -1
- data/reveal.js/index.html +9 -4
- data/reveal.js/js/reveal.js +804 -199
- data/reveal.js/js/reveal.min.js +3 -2
- data/reveal.js/package.json +1 -1
- data/reveal.js/plugin/highlight/highlight.js +3 -2
- data/reveal.js/plugin/markdown/example.html +34 -3
- data/reveal.js/plugin/markdown/markdown.js +75 -3
- data/reveal.js/plugin/notes/notes.html +10 -6
- data/reveal.js/plugin/remotes/remotes.js +1 -1
- data/reveal.js/plugin/zoom-js/zoom.js +3 -1
- data/reveal.js/test/examples/barebones.html +0 -1
- data/reveal.js/test/examples/slide-backgrounds.html +22 -1
- data/reveal.js/test/test-markdown-element-attributes.html +134 -0
- data/reveal.js/test/test-markdown-element-attributes.js +46 -0
- data/reveal.js/test/test-markdown-slide-attributes.html +128 -0
- data/reveal.js/test/test-markdown-slide-attributes.js +47 -0
- data/reveal.js/test/test.html +26 -7
- data/reveal.js/test/test.js +95 -10
- data/spec/lib/reveal-ck/markdown/slide_markdown_spec.rb +76 -0
- data/spec/lib/reveal-ck/markdown/slide_markdown_template_spec.rb +29 -0
- data/spec/lib/reveal-ck/tilt/config_spec.rb +9 -0
- metadata +34 -4
checksums.yaml
CHANGED
@@ -1,15 +1,15 @@
|
|
1
1
|
---
|
2
2
|
!binary "U0hBMQ==":
|
3
3
|
metadata.gz: !binary |-
|
4
|
-
|
4
|
+
MzEyM2QwYjU3YTliMGZkYzJmYzdlMjUxNDI2NzA3ZmI0MjAyNzBjMw==
|
5
5
|
data.tar.gz: !binary |-
|
6
|
-
|
6
|
+
NDQwNWUwYmI3YzUyMTA4NzAwMDg2YmEzYWIxYWM0M2E5YzQxMjYxNQ==
|
7
7
|
!binary "U0hBNTEy":
|
8
8
|
metadata.gz: !binary |-
|
9
|
-
|
10
|
-
|
11
|
-
|
9
|
+
YWJmODY1YjNhNTZlZmNhMTZlMmY5YTA5M2JiMzFlZWE1ZGZlN2EyODMzZDU0
|
10
|
+
MDU3Y2NhNTBkYzk3NWJiNWFlZGZkNGQ5YTVlMTVkMjE3OTJmNzFlM2FlMmEw
|
11
|
+
NTE0ZjAwY2QzMjk4MDAyYzQ1N2U2MDZiYWY3NGI3ZTRmYWZkNWY=
|
12
12
|
data.tar.gz: !binary |-
|
13
|
-
|
14
|
-
|
15
|
-
|
13
|
+
YjYzMWU5MWE1NjU5ZDZiMjlkYzJiNTM5ODQ2MmQ4OTFiOWIyYWQ4MDA4NGE1
|
14
|
+
ZGM5YmQ5NDIxOTBiMjQ4NjFhOTk4MzJjNDRmZGVhMjFmZTYxMDM5YWFhZDM0
|
15
|
+
ZmNiYjVmMmZiZTk1NzkyNTk4MmU4MTY5NDRlM2I0ZjAzMDEwMTA=
|
data/README.md
CHANGED
@@ -1,18 +1,10 @@
|
|
1
1
|
# reveal-ck: Make Slides with Ruby
|
2
2
|
|
3
|
-
[![Build Status][travis]](https://travis-ci.org/jedcn/reveal-ck)
|
4
|
-
[![Code Climate][code-climate]](https://codeclimate.com/github/jedcn/reveal-ck)
|
5
|
-
|
6
|
-
## Overview
|
7
|
-
|
8
3
|
This project lets you author slides with a Ruby toolset.
|
9
4
|
|
10
|
-
You write in Haml or
|
11
|
-
|
12
|
-
|
5
|
+
You write in Haml or Slim or Ruby. The end result
|
6
|
+
[looks like this][reveal.js].
|
13
7
|
|
14
|
-
|
8
|
+
Introduction available at http://jedcn.github.io/reveal-ck.
|
15
9
|
|
16
|
-
[code-climate]: https://codeclimate.com/github/jedcn/reveal-ck.png
|
17
|
-
[travis]: https://travis-ci.org/jedcn/reveal-ck.png
|
18
10
|
[reveal.js]: http://lab.hakim.se/reveal-js
|
data/bin/reveal-ck
CHANGED
@@ -12,9 +12,11 @@ desc 'Generate reveal.js slides'
|
|
12
12
|
command :generate do |c|
|
13
13
|
|
14
14
|
# Where is the slides file?
|
15
|
-
default_file = 'slides.
|
16
|
-
default_file = 'slides.
|
17
|
-
default_file = 'slides.
|
15
|
+
default_file = 'slides.md' if File.exists? 'slides.md'
|
16
|
+
default_file = 'slides.textile' if File.exists? 'slides.textile'
|
17
|
+
default_file = 'slides.haml' if File.exists? 'slides.haml'
|
18
|
+
default_file = 'slides.slim' if File.exists? 'slides.slim'
|
19
|
+
default_file = 'slides.rb' if File.exists? 'slides.rb'
|
18
20
|
c.desc 'The file containing your slides'
|
19
21
|
c.flag [:f, :file], default_value: default_file
|
20
22
|
|
@@ -31,6 +33,8 @@ command :generate do |c|
|
|
31
33
|
presentation
|
32
34
|
.merge_config({ file: 'config.yml' }) if File.exists?('config.yml')
|
33
35
|
|
36
|
+
puts "Generating slides for '#{slides_file}'.."
|
37
|
+
|
34
38
|
builder =
|
35
39
|
RevealCK::Builders::PackagedSlides.new({
|
36
40
|
image_files: image_files,
|
@@ -41,6 +45,37 @@ command :generate do |c|
|
|
41
45
|
end
|
42
46
|
end
|
43
47
|
|
48
|
+
desc 'Start webserver so slides are available via http'
|
49
|
+
command :serve, :server do |c|
|
50
|
+
|
51
|
+
c.desc 'The directory to serve up'
|
52
|
+
c.flag [:d, :dir], default_value: 'slides'
|
53
|
+
|
54
|
+
c.desc 'The port to serve on'
|
55
|
+
c.flag [:p, :port], default_value: 10000
|
56
|
+
|
57
|
+
c.action do |global_options, options, args|
|
58
|
+
dir = options[:dir]
|
59
|
+
port = options[:port]
|
60
|
+
|
61
|
+
require 'webrick'
|
62
|
+
server = WEBrick::HTTPServer.new :Port => port, :DocumentRoot => dir
|
63
|
+
trap('INT') { server.shutdown }
|
64
|
+
|
65
|
+
puts ""
|
66
|
+
puts ""
|
67
|
+
puts "\tServing up slide content in '#{dir}/'."
|
68
|
+
puts ""
|
69
|
+
puts "\tOpen your browser to 'http://localhost:#{port}'."
|
70
|
+
puts ""
|
71
|
+
puts "\tPress CTRL-C to stop serving slides."
|
72
|
+
puts ""
|
73
|
+
puts ""
|
74
|
+
server.start
|
75
|
+
end
|
76
|
+
|
77
|
+
end
|
78
|
+
|
44
79
|
pre do |global, command, options, args|
|
45
80
|
# Pre logic here
|
46
81
|
# Return true to proceed; false to abort and not call the
|
data/lib/reveal-ck.rb
CHANGED
@@ -6,6 +6,8 @@ require_relative 'reveal-ck/presentation_dsl'
|
|
6
6
|
require_relative 'reveal-ck/templates'
|
7
7
|
require_relative 'reveal-ck/changers'
|
8
8
|
require_relative 'reveal-ck/builders'
|
9
|
+
require_relative 'reveal-ck/markdown'
|
10
|
+
require_relative 'reveal-ck/tilt/config'
|
9
11
|
|
10
12
|
# RevealCK::LOCATION is the path where reveal-ck is residing on your
|
11
13
|
# system as a gem.
|
@@ -0,0 +1,22 @@
|
|
1
|
+
require 'redcarpet'
|
2
|
+
|
3
|
+
module RevealCK
|
4
|
+
module Markdown
|
5
|
+
class SlideMarkdown < Redcarpet::Render::HTML
|
6
|
+
|
7
|
+
HR = '<hr>'
|
8
|
+
HR_NEWLINE = "<hr>\n"
|
9
|
+
|
10
|
+
SLIDE_START = '<section>'
|
11
|
+
SLIDE_END = '</section>'
|
12
|
+
SLIDE_DIVIDER = "#{SLIDE_END}\n#{SLIDE_START}"
|
13
|
+
|
14
|
+
def postprocess(doc)
|
15
|
+
doc = doc[HR.size, doc.size-1] if doc.start_with?(HR)
|
16
|
+
doc = doc[0, doc.size-1-HR_NEWLINE.size] if doc.end_with?(HR_NEWLINE)
|
17
|
+
doc = doc.gsub(HR, SLIDE_DIVIDER)
|
18
|
+
"#{SLIDE_START}\n#{doc}\n#{SLIDE_END}"
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
require 'tilt/template'
|
2
|
+
|
3
|
+
module RevealCK
|
4
|
+
module Markdown
|
5
|
+
#
|
6
|
+
# Public: This class allows SlideMarkdown to hook into Tilt 2.0. See
|
7
|
+
# https://github.com/rtomayko/tilt.
|
8
|
+
#
|
9
|
+
class SlideMarkdownTemplate < ::Tilt::Template
|
10
|
+
|
11
|
+
# Must be implemented by all subclasses of Tilt::Template
|
12
|
+
def prepare
|
13
|
+
end
|
14
|
+
|
15
|
+
def evaluate(scope, locals, &block)
|
16
|
+
markdown = Redcarpet::Markdown.new(SlideMarkdown, :fenced_code_blocks => true)
|
17
|
+
@output = markdown.render(data)
|
18
|
+
end
|
19
|
+
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
data/lib/reveal-ck/version.rb
CHANGED
data/reveal.js/Gruntfile.js
CHANGED
@@ -15,7 +15,6 @@ module.exports = function(grunt) {
|
|
15
15
|
' */'
|
16
16
|
},
|
17
17
|
|
18
|
-
// Tests will be added soon
|
19
18
|
qunit: {
|
20
19
|
files: [ 'test/*.html' ]
|
21
20
|
},
|
@@ -48,7 +47,8 @@ module.exports = function(grunt) {
|
|
48
47
|
'css/theme/simple.css': 'css/theme/source/simple.scss',
|
49
48
|
'css/theme/sky.css': 'css/theme/source/sky.scss',
|
50
49
|
'css/theme/moon.css': 'css/theme/source/moon.scss',
|
51
|
-
'css/theme/solarized.css': 'css/theme/source/solarized.scss'
|
50
|
+
'css/theme/solarized.css': 'css/theme/source/solarized.scss',
|
51
|
+
'css/theme/blood.css': 'css/theme/source/blood.scss'
|
52
52
|
}
|
53
53
|
}
|
54
54
|
},
|
@@ -69,7 +69,8 @@ module.exports = function(grunt) {
|
|
69
69
|
globals: {
|
70
70
|
head: false,
|
71
71
|
module: false,
|
72
|
-
console: false
|
72
|
+
console: false,
|
73
|
+
unescape: false
|
73
74
|
}
|
74
75
|
},
|
75
76
|
files: [ 'Gruntfile.js', 'js/reveal.js' ]
|
data/reveal.js/README.md
CHANGED
@@ -11,7 +11,7 @@ reveal.js comes with a broad range of features including [nested slides](https:/
|
|
11
11
|
- [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own!
|
12
12
|
- [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks.
|
13
13
|
|
14
|
-
##
|
14
|
+
## Online Editor
|
15
15
|
|
16
16
|
Presentations are written using HTML or markdown but there's also an online editor for those of you who prefer a graphical interface. Give it a try at [http://slid.es](http://slid.es).
|
17
17
|
|
@@ -54,10 +54,44 @@ This is based on [data-markdown](https://gist.github.com/1343518) from [Paul Iri
|
|
54
54
|
|
55
55
|
You can write your content as a separate file and have reveal.js load it at runtime. Note the separator arguments which determine how slides are delimited in the external file. The ```data-charset``` attribute is optional and specifies which charset to use when loading the external file.
|
56
56
|
|
57
|
+
When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup).
|
58
|
+
|
57
59
|
```html
|
58
|
-
<section data-markdown="example.md"
|
60
|
+
<section data-markdown="example.md"
|
61
|
+
data-separator="^\n\n\n"
|
62
|
+
data-vertical="^\n\n"
|
63
|
+
data-notes="^Note:"
|
64
|
+
data-charset="iso-8859-15">
|
65
|
+
</section>
|
59
66
|
```
|
60
67
|
|
68
|
+
#### Element Attributes
|
69
|
+
|
70
|
+
Special syntax (in html comment) is available for adding attributes to Markdown elements. This is useful for fragments, amongst other things.
|
71
|
+
|
72
|
+
```html
|
73
|
+
<section data-markdown>
|
74
|
+
<script type="text/template">
|
75
|
+
- Item 1 <!-- .element: class="fragment" data-fragment-index="2" -->
|
76
|
+
- Item 2 <!-- .element: class="fragment" data-fragment-index="1" -->
|
77
|
+
</script>
|
78
|
+
</section>
|
79
|
+
```
|
80
|
+
|
81
|
+
#### Slide Attributes
|
82
|
+
|
83
|
+
Special syntax (in html comment) is available for adding attributes to the slide `<section>` elements generated by your Markdown.
|
84
|
+
|
85
|
+
```html
|
86
|
+
<section data-markdown>
|
87
|
+
<script type="text/template">
|
88
|
+
<!-- .slide: data-background="#ff0000" -->
|
89
|
+
Mardown content
|
90
|
+
</script>
|
91
|
+
</section>
|
92
|
+
```
|
93
|
+
|
94
|
+
|
61
95
|
### Configuration
|
62
96
|
|
63
97
|
At the end of your page you need to initialize reveal by running the following code. Note that all config values are optional and will default as specified below.
|
@@ -71,43 +105,72 @@ Reveal.initialize({
|
|
71
105
|
// Display a presentation progress bar
|
72
106
|
progress: true,
|
73
107
|
|
108
|
+
// Display the page number of the current slide
|
109
|
+
slideNumber: false,
|
110
|
+
|
74
111
|
// Push each slide change to the browser history
|
75
112
|
history: false,
|
76
113
|
|
77
114
|
// Enable keyboard shortcuts for navigation
|
78
115
|
keyboard: true,
|
79
116
|
|
80
|
-
// Enable touch events for navigation
|
81
|
-
touch: true,
|
82
|
-
|
83
117
|
// Enable the slide overview mode
|
84
118
|
overview: true,
|
85
119
|
|
86
120
|
// Vertical centering of slides
|
87
121
|
center: true,
|
88
122
|
|
123
|
+
// Enables touch navigation on devices with touch input
|
124
|
+
touch: true,
|
125
|
+
|
89
126
|
// Loop the presentation
|
90
127
|
loop: false,
|
91
128
|
|
92
129
|
// Change the presentation direction to be RTL
|
93
130
|
rtl: false,
|
94
131
|
|
132
|
+
// Turns fragments on and off globally
|
133
|
+
fragments: true,
|
134
|
+
|
135
|
+
// Flags if the presentation is running in an embedded mode,
|
136
|
+
// i.e. contained within a limited portion of the screen
|
137
|
+
embedded: false,
|
138
|
+
|
95
139
|
// Number of milliseconds between automatically proceeding to the
|
96
140
|
// next slide, disabled when set to 0, this value can be overwritten
|
97
141
|
// by using a data-autoslide attribute on your slides
|
98
142
|
autoSlide: 0,
|
99
143
|
|
144
|
+
// Stop auto-sliding after user input
|
145
|
+
autoSlideStoppable: true,
|
146
|
+
|
100
147
|
// Enable slide navigation via mouse wheel
|
101
148
|
mouseWheel: false,
|
102
149
|
|
150
|
+
// Hides the address bar on mobile devices
|
151
|
+
hideAddressBar: true,
|
152
|
+
|
153
|
+
// Opens links in an iframe preview overlay
|
154
|
+
previewLinks: false,
|
155
|
+
|
103
156
|
// Transition style
|
104
157
|
transition: 'default', // default/cube/page/concave/zoom/linear/fade/none
|
105
158
|
|
106
159
|
// Transition speed
|
107
160
|
transitionSpeed: 'default', // default/fast/slow
|
108
161
|
|
109
|
-
// Transition style for full page backgrounds
|
110
|
-
backgroundTransition: 'default' // default/
|
162
|
+
// Transition style for full page slide backgrounds
|
163
|
+
backgroundTransition: 'default', // default/none/slide/concave/convex/zoom
|
164
|
+
|
165
|
+
// Number of slides away from the current that are visible
|
166
|
+
viewDistance: 3,
|
167
|
+
|
168
|
+
// Parallax background image
|
169
|
+
parallaxBackgroundImage: '', // e.g. "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'"
|
170
|
+
|
171
|
+
// Parallax background size
|
172
|
+
parallaxBackgroundSize: '' // CSS syntax, e.g. "2100px 900px"
|
173
|
+
|
111
174
|
|
112
175
|
});
|
113
176
|
```
|
@@ -192,6 +255,27 @@ Reveal.initialize({
|
|
192
255
|
});
|
193
256
|
```
|
194
257
|
|
258
|
+
|
259
|
+
### Auto-sliding
|
260
|
+
|
261
|
+
Presentations can be configure to progress through slides automatically, without any user input. To enable this you will need to tell the framework how many milliseconds it should wait between slides:
|
262
|
+
|
263
|
+
```javascript
|
264
|
+
// Slide every five seconds
|
265
|
+
Reveal.configure({
|
266
|
+
autoSlide: 5000
|
267
|
+
});
|
268
|
+
```
|
269
|
+
|
270
|
+
When this is turned on a control element will appear that enables users to pause and resume auto-sliding. Sliding is also paused automatically as soon as the user starts navigating. You can disable these controls by specifying ```autoSlideStoppable: false``` in your reveal.js config.
|
271
|
+
|
272
|
+
You can also override the slide duration for individual slides by using the ```data-autoslide``` attribute on individual sections:
|
273
|
+
|
274
|
+
```html
|
275
|
+
<section data-autoslide="10000">This will remain on screen for 10 seconds</section>
|
276
|
+
```
|
277
|
+
|
278
|
+
|
195
279
|
### Keyboard Bindings
|
196
280
|
|
197
281
|
If you're unhappy with any of the default keyboard bindings you can override them using the ```keyboard``` config option:
|
@@ -292,6 +376,29 @@ Slides are contained within a limited portion of the screen by default to allow
|
|
292
376
|
Backgrounds transition using a fade animation by default. This can be changed to a linear sliding transition by passing ```backgroundTransition: 'slide'``` to the ```Reveal.initialize()``` call. Alternatively you can set ```data-background-transition``` on any section with a background to override that specific transition.
|
293
377
|
|
294
378
|
|
379
|
+
### Parallax Background
|
380
|
+
|
381
|
+
If you want to use a parallax scrolling background, set the two following config properties when initializing reveal.js (the third one is optional).
|
382
|
+
|
383
|
+
```javascript
|
384
|
+
Reveal.initialize({
|
385
|
+
|
386
|
+
// Parallax background image
|
387
|
+
parallaxBackgroundImage: '', // e.g. "https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg"
|
388
|
+
|
389
|
+
// Parallax background size
|
390
|
+
parallaxBackgroundSize: '', // CSS syntax, e.g. "2100px 900px" - currently only pixels are supported (don't use % or auto)
|
391
|
+
|
392
|
+
// This slide transition gives best results:
|
393
|
+
transition: linear
|
394
|
+
|
395
|
+
});
|
396
|
+
```
|
397
|
+
|
398
|
+
Make sure that the background size is much bigger than screen size to allow for some scrolling. [View example](http://lab.hakim.se/reveal-js/?parallaxBackgroundImage=https%3A%2F%2Fs3.amazonaws.com%2Fhakim-static%2Freveal-js%2Freveal-parallax-1.jpg¶llaxBackgroundSize=2100px%20900px).
|
399
|
+
|
400
|
+
|
401
|
+
|
295
402
|
### Slide Transitions
|
296
403
|
The global presentation transition is set using the ```transition``` config value. You can override the global transition for a specific slide by using the ```data-transition``` attribute:
|
297
404
|
|
@@ -330,7 +437,7 @@ You can also add relative navigation links, similar to the built in reveal.js co
|
|
330
437
|
|
331
438
|
|
332
439
|
### Fragments
|
333
|
-
Fragments are used to highlight individual elements on a slide. Every element with the class ```fragment``` will be stepped through before moving on to the next slide. Here's an example: http://lab.hakim.se/reveal-js/#/
|
440
|
+
Fragments are used to highlight individual elements on a slide. Every element with the class ```fragment``` will be stepped through before moving on to the next slide. Here's an example: http://lab.hakim.se/reveal-js/#/fragments
|
334
441
|
|
335
442
|
The default fragment style is to start out invisible and fade in. This style can be changed by appending a different class to the fragment:
|
336
443
|
|
@@ -340,6 +447,8 @@ The default fragment style is to start out invisible and fade in. This style can
|
|
340
447
|
<p class="fragment shrink">shrink</p>
|
341
448
|
<p class="fragment roll-in">roll-in</p>
|
342
449
|
<p class="fragment fade-out">fade-out</p>
|
450
|
+
<p class="fragment current-visible">visible only once</p>
|
451
|
+
<p class="fragment highlight-current-blue">blue only once</p>
|
343
452
|
<p class="fragment highlight-red">highlight-red</p>
|
344
453
|
<p class="fragment highlight-green">highlight-green</p>
|
345
454
|
<p class="fragment highlight-blue">highlight-blue</p>
|
@@ -397,6 +506,13 @@ By default, Reveal is configured with [highlight.js](http://softwaremaniacs.org/
|
|
397
506
|
</section>
|
398
507
|
```
|
399
508
|
|
509
|
+
### Slide number
|
510
|
+
If you would like to display the page number of the current slide you can do so using the ```slideNumber``` configuration value.
|
511
|
+
|
512
|
+
```javascript
|
513
|
+
Reveal.configure({ slideNumber: true });
|
514
|
+
```
|
515
|
+
|
400
516
|
|
401
517
|
### Overview mode
|
402
518
|
|
@@ -424,6 +540,8 @@ Add `data-autoplay` to your media element if you want it to automatically start
|
|
424
540
|
<video data-autoplay src="http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4"></video>
|
425
541
|
```
|
426
542
|
|
543
|
+
Additionally the framework automatically pushes two [post messages](https://developer.mozilla.org/en-US/docs/Web/API/Window.postMessage) to all iframes, ```slide:start``` when the slide containing the iframe is made visible and ```slide:stop``` when it is hidden.
|
544
|
+
|
427
545
|
|
428
546
|
### Stretching elements
|
429
547
|
Sometimes it's desirable to have an element, like an image or video, stretch to consume as much space as possible within a given slide. This can be done by adding the ```.stretch``` class to an element as seen below:
|
@@ -464,6 +582,7 @@ The framework comes with a few different themes included:
|
|
464
582
|
- night: Black background, thick white text, orange links
|
465
583
|
- serif: Cappuccino background, gray text, brown links
|
466
584
|
- simple: White background, black text, blue links
|
585
|
+
- solarized: Cream-colored background, dark green text, blue links
|
467
586
|
|
468
587
|
Each theme is available as a separate stylesheet. To change theme you will need to replace **default** below with your desired theme name in index.html:
|
469
588
|
|
@@ -480,6 +599,8 @@ reveal.js comes with a speaker notes plugin which can be used to present per-sli
|
|
480
599
|
|
481
600
|
Notes are defined by appending an ```<aside>``` element to a slide as seen below. You can add the ```data-markdown``` attribute to the aside element if you prefer writing notes using Markdown.
|
482
601
|
|
602
|
+
When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup).
|
603
|
+
|
483
604
|
```html
|
484
605
|
<section>
|
485
606
|
<h2>Some Slide</h2>
|
@@ -750,29 +871,29 @@ The core of reveal.js is very easy to install. You'll simply need to download a
|
|
750
871
|
|
751
872
|
### Full setup
|
752
873
|
|
753
|
-
Some reveal.js features, like external markdown, require that presentations run from a local web server. The following instructions will set up such a server as well as all of the development tasks needed to make edits to the reveal.js source code.
|
874
|
+
Some reveal.js features, like external markdown and speaker notes, require that presentations run from a local web server. The following instructions will set up such a server as well as all of the development tasks needed to make edits to the reveal.js source code.
|
754
875
|
|
755
876
|
1. Install [Node.js](http://nodejs.org/)
|
756
877
|
|
757
878
|
2. Install [Grunt](http://gruntjs.com/getting-started#installing-the-cli)
|
758
879
|
|
759
880
|
4. Clone the reveal.js repository
|
760
|
-
```
|
881
|
+
```sh
|
761
882
|
$ git clone https://github.com/hakimel/reveal.js.git
|
762
883
|
```
|
763
884
|
|
764
885
|
5. Navigate to the reveal.js folder
|
765
|
-
```
|
886
|
+
```sh
|
766
887
|
$ cd reveal.js
|
767
888
|
```
|
768
889
|
|
769
890
|
6. Install dependencies
|
770
|
-
```
|
891
|
+
```sh
|
771
892
|
$ npm install
|
772
893
|
```
|
773
894
|
|
774
895
|
7. Serve the presentation and monitor source files for changes
|
775
|
-
```
|
896
|
+
```sh
|
776
897
|
$ grunt serve
|
777
898
|
```
|
778
899
|
|
@@ -802,6 +923,7 @@ If you have personal support questions use [StackOverflow](http://stackoverflow.
|
|
802
923
|
- Single-quoted strings
|
803
924
|
- Should be made towards the **dev branch**
|
804
925
|
- Should be submitted from a feature/topic branch (not your master)
|
926
|
+
- Should not include the minified **reveal.min.js** file
|
805
927
|
|
806
928
|
|
807
929
|
## License
|