reveal-ck 0.5.0 → 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +110 -19
- data/lib/reveal-ck/version.rb +1 -1
- metadata +16 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: dd2b86c0a0576b5b59ad5155588c7eaeaf44e306
|
|
4
|
+
data.tar.gz: 9f32b3f097e4955fa9d4e72aa8a6c16b8f29fe63
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a0ddd3ed0a7d2a435a0d43d8e761e3ae41570e172d4481edd980524ac0c8c9e4cbd4b403990c415d7bbaa78b3bc06119ff4b8e056d333cb7cd16a1a56e391c04
|
|
7
|
+
data.tar.gz: 8c1ec8d9f99d67f7ff1331a4bd16712f1b707be810ea6b9ed58d080d3e6358201000fce8f62eca878dbc3e38d9cf80f5ab8ebb291a43a89d01e2de58c9bfb1d4
|
data/README.md
CHANGED
|
@@ -2,37 +2,128 @@
|
|
|
2
2
|
|
|
3
3
|
[](http://badge.fury.io/rb/reveal-ck)
|
|
4
4
|
|
|
5
|
-
reveal-ck
|
|
6
|
-
popular markup and templating languages.
|
|
5
|
+
reveal-ck helps you author [reveal.js][reveal.js] presentations.
|
|
7
6
|
|
|
8
|
-
|
|
7
|
+
## How do I get started?
|
|
9
8
|
|
|
10
|
-
|
|
9
|
+
* Install [the reveal-ck gem][reveal-ck-gem]
|
|
10
|
+
* Copy and paste the following, and save it in a file named
|
|
11
|
+
`slides.md`:
|
|
12
|
+
```
|
|
13
|
+
## i :heart: reveal.js
|
|
14
|
+
---
|
|
15
|
+
## This is your
|
|
16
|
+
* presentation
|
|
17
|
+
* content
|
|
18
|
+
* in a single file
|
|
19
|
+
---
|
|
20
|
+
1. markdown
|
|
21
|
+
2. html
|
|
22
|
+
3. erb
|
|
23
|
+
4. haml
|
|
24
|
+
5. slim
|
|
25
|
+
6. ruby
|
|
26
|
+
---
|
|
27
|
+
## :zap: LiveReload is builtin :zap:
|
|
28
|
+
---
|
|
29
|
+
## See also:
|
|
30
|
+
http://jedcn.github.io/reveal-ck/
|
|
31
|
+
---
|
|
32
|
+
## Questions? Problems?
|
|
33
|
+
Let me know, @jedcn
|
|
34
|
+
---
|
|
35
|
+
# Thanks!
|
|
36
|
+
```
|
|
37
|
+
* Open a terminal and change to the directory with your new
|
|
38
|
+
`slides.md`
|
|
39
|
+
* Run `reveal-ck generate` followed by `reveal-ck serve`. You should
|
|
40
|
+
see:
|
|
41
|
+
```
|
|
42
|
+
$ reveal-ck generate
|
|
43
|
+
Generating slides for 'slides.md'..
|
|
44
|
+
$ reveal-ck serve
|
|
45
|
+
------------------------------------------------------------
|
|
46
|
+
[ reveal-ck ] Serving up slide content in 'slides/'.
|
|
47
|
+
[ reveal-ck ] Open your browser to 'http://localhost:10000'.
|
|
48
|
+
[ reveal-ck ] Press CTRL-C to stop.
|
|
49
|
+
------------------------------------------------------------
|
|
50
|
+
[ reveal-ck ] Getting Ready to Reload Browsers.
|
|
51
|
+
[ reload ] Using Guardfile at ...
|
|
52
|
+
[ reload ] LiveReload is waiting for a browser to connect.
|
|
53
|
+
[ reload ] Guard is now watching at 'whereever'
|
|
54
|
+
[ reveal-ck ] Getting Ready to Rebuild Slides.
|
|
55
|
+
[ reveal-ck ] Starting Webserver.
|
|
56
|
+
```
|
|
11
57
|
|
|
12
|
-
|
|
58
|
+
Now view the slide deck generated from this single file by opening
|
|
59
|
+
your browser to [http://localhost:10000][localhost].
|
|
13
60
|
|
|
14
|
-
|
|
61
|
+
Check back at the terminal where the serve command is running and see
|
|
62
|
+
that reveal-ck is aware that you're viewing your slides:
|
|
15
63
|
|
|
16
|
-
|
|
64
|
+
```
|
|
65
|
+
[ reload ] Browser connected.
|
|
66
|
+
```
|
|
17
67
|
|
|
18
|
-
|
|
19
|
-
<img alt="Video Thumbnail" width="306" height="178" src='https://raw2.github.com/jedcn/reveal-ck/gh-pages/images/reveal-ck-introduction-thumbnail.png' />
|
|
20
|
-
</a>
|
|
68
|
+
## And then?
|
|
21
69
|
|
|
22
|
-
|
|
70
|
+
Use your editor and make a change to the `slides.md` file.
|
|
23
71
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
</a>
|
|
72
|
+
reveal-ck will see the change, rebuild your slides, and reload your
|
|
73
|
+
browser for you.
|
|
27
74
|
|
|
28
|
-
*
|
|
75
|
+
As a final step *for now*, create a file named `config.yml` alongside
|
|
76
|
+
the `slides.md` and add a single line:
|
|
29
77
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
78
|
+
```
|
|
79
|
+
theme: night
|
|
80
|
+
```
|
|
33
81
|
|
|
82
|
+
And your slides will take on the night theme from reveal.js.
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## What is it like?
|
|
87
|
+
|
|
88
|
+
Here's a quick example of what it's like to work with reveal-ck:
|
|
89
|
+
|
|
90
|
+
* Normally you'd use a text editor, but for brevity, this example
|
|
91
|
+
creates a file named `slides.md` with the `echo` command.
|
|
92
|
+
* A presentation is then generated with `reveal-ck generate`.
|
|
93
|
+
* That presentation is viewed with `open slides/index.html`. You'd
|
|
94
|
+
normally run a `reveal-ck serve` and then view
|
|
95
|
+
[https://localhost:10000][localhost]
|
|
96
|
+
* Next, a theme is introduced by supplying a `config.yml` file.
|
|
97
|
+
* That theme comes into play when the same presentation is generated
|
|
98
|
+
again.
|
|
99
|
+
* Finally, the presentation is viewed again with `open slides/index.html`
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## Where does this leave us?
|
|
106
|
+
|
|
107
|
+
* reveal-ck helps you build reveal.js presentations
|
|
108
|
+
* your content is stored in a single file so you can easily track it
|
|
109
|
+
(**with git**) and review it (**with your brain**)
|
|
110
|
+
* write in markdown or the html-ish language of your choice
|
|
111
|
+
|
|
112
|
+
If find these ideas intriguing, you can learn more at
|
|
113
|
+
http://jedcn.github.io/reveal-ck/.
|
|
114
|
+
|
|
115
|
+
## Questions?
|
|
116
|
+
|
|
117
|
+
If you have questions, find me on github ([@jedcn][github-jedcn]) or
|
|
118
|
+
twitter ([@jedcn][twitter-jedcn]), open an issue, or email me at
|
|
119
|
+
revealck@jedcn.com.
|
|
34
120
|
|
|
35
121
|
[](https://travis-ci.org/jedcn/reveal-ck)
|
|
36
122
|
[](https://codeclimate.com/github/jedcn/reveal-ck)
|
|
37
123
|
|
|
38
|
-
[reveal.js]:
|
|
124
|
+
[reveal.js]: http://lab.hakim.se/reveal-js
|
|
125
|
+
[github-jedcn]: https://github.com/jedcn
|
|
126
|
+
[twitter-jedcn]: https://twitter.com/jedcn
|
|
127
|
+
[reveal-ck-gem]: https://rubygems.org/gems/reveal-ck
|
|
128
|
+
[localhost]: http://localhost:10000
|
|
129
|
+
[github-pages]: https://pages.github.com/
|
data/lib/reveal-ck/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: reveal-ck
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.5.
|
|
4
|
+
version: 0.5.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Jed Northridge
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2014-
|
|
11
|
+
date: 2014-11-01 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: RedCloth
|
|
@@ -66,6 +66,20 @@ dependencies:
|
|
|
66
66
|
- - "~>"
|
|
67
67
|
- !ruby/object:Gem::Version
|
|
68
68
|
version: '2.7'
|
|
69
|
+
- !ruby/object:Gem::Dependency
|
|
70
|
+
name: guard
|
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - "~>"
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: 2.6.1
|
|
76
|
+
type: :runtime
|
|
77
|
+
prerelease: false
|
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
79
|
+
requirements:
|
|
80
|
+
- - "~>"
|
|
81
|
+
- !ruby/object:Gem::Version
|
|
82
|
+
version: 2.6.1
|
|
69
83
|
- !ruby/object:Gem::Dependency
|
|
70
84
|
name: guard-livereload
|
|
71
85
|
requirement: !ruby/object:Gem::Requirement
|