reveal-jekyll 0.0.2 → 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +32 -10
- metadata +2 -22
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 86c23bed672113ecc49e483c9c9aabc1e23a4d1b6d0d5f757aaa910f07a9d0ce
|
|
4
|
+
data.tar.gz: bdf8cfd084bc467c20f46f6f4dee23bc57eae7edcc4e496aaeb38cd6a18c4aa9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 410a5dd63ee247f84fc79633f420c816bc08d7817222e20d8c52caae5b56ecfe822fcd1045a1ed6d98f2365debedd6fefd421a41343ad1a0d0c66abc2073a1cc
|
|
7
|
+
data.tar.gz: 0aa52a9a7d1947aa5396d3b98b8774a24a13173a358eafafe202174cb479c5fafd306ea352cbe12e5f3fb9b8b65b386e321cb156b92251d2806679b5cf6c5b2b
|
data/README.md
CHANGED
|
@@ -1,29 +1,39 @@
|
|
|
1
1
|
# Reveal Jekyll
|
|
2
2
|
|
|
3
|
+
[](https://travis-ci.org/sylhare/Reveal-Jekyll)
|
|
4
|
+
[](https://badge.fury.io/rb/reveal-jekyll)
|
|
5
|
+
|
|
3
6
|
Reveal.js Web presentation served with jekyll.
|
|
4
7
|
|
|
5
8
|
## Set up
|
|
6
9
|
|
|
10
|
+
Make sure to install bundle which will ease the installation of jekyll:
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
gem install bundle
|
|
14
|
+
bundle install
|
|
15
|
+
```
|
|
16
|
+
|
|
7
17
|
Run the presentation using:
|
|
8
18
|
|
|
9
19
|
```bash
|
|
10
20
|
bundle exec jekyll serve
|
|
11
21
|
```
|
|
12
22
|
|
|
13
|
-
|
|
23
|
+
## Create your presentation
|
|
14
24
|
|
|
15
|
-
|
|
25
|
+
### Raw Markdown
|
|
16
26
|
|
|
17
27
|
In `index.html` use the `layout: raw` and then you can create your slides directly in the file using markdown:
|
|
18
28
|
|
|
19
29
|
- `___` Makes a basement slide
|
|
20
30
|
- `---` Makes the next slide
|
|
21
31
|
|
|
22
|
-
|
|
32
|
+
### Using Jekyll capabilities
|
|
23
33
|
|
|
24
34
|
In `index.html` use the `layout: presentation`. It will use the `_slides` and `_basements` folder to create the presentation.
|
|
25
35
|
|
|
26
|
-
|
|
36
|
+
#### Slide
|
|
27
37
|
|
|
28
38
|
Use the `_slides` folder to create a file per slide in markdown.
|
|
29
39
|
|
|
@@ -42,7 +52,7 @@ Slide content in markdown
|
|
|
42
52
|
|
|
43
53
|
To order the presentation you can do something like `01-First-slide-title.md`, `02-Second-slide-title.md`.
|
|
44
54
|
|
|
45
|
-
|
|
55
|
+
#### Basement slides
|
|
46
56
|
|
|
47
57
|
Basement slides can be put in the `_basements` folder.
|
|
48
58
|
The Basement slides are slides that will be accessible using the down arrow when on a particular slide.
|
|
@@ -61,7 +71,7 @@ Content of the Basement slide in markdown
|
|
|
61
71
|
|
|
62
72
|
> Don't forget to use the `slide` attribute to specify under which slide it will fit.
|
|
63
73
|
|
|
64
|
-
|
|
74
|
+
#### Config
|
|
65
75
|
|
|
66
76
|
Configure Reveal.js in teh `_config.yml`:
|
|
67
77
|
|
|
@@ -73,21 +83,33 @@ reveal:
|
|
|
73
83
|
|
|
74
84
|
You can set globally the transitions and theme of your presentation.
|
|
75
85
|
|
|
76
|
-
|
|
86
|
+
### Use as a gem
|
|
87
|
+
|
|
88
|
+
There is a `Dockerfile` available, check it out to see how to use the theme in a Docker.
|
|
89
|
+
Basically you need 4 things to make it work as a gem:
|
|
90
|
+
|
|
91
|
+
- The Gemfile with the [reveal-jekyll gem](https://rubygems.org/gems/reveal-jekyll): `gem 'reveal-jekyll', '~> 0.0.2'`
|
|
92
|
+
- The `index.html` which is the entrypoint of your jekyll site and presentation (with explained above configuration)
|
|
93
|
+
- The `_config.yml` which defines your theme configuration.
|
|
94
|
+
- The presentation, assets and content you want to display.
|
|
95
|
+
|
|
96
|
+
And that's it you'd be good to roll!
|
|
97
|
+
|
|
98
|
+
## License
|
|
77
99
|
|
|
78
|
-
|
|
100
|
+
### Reveal Jekyll
|
|
79
101
|
|
|
80
102
|
[Reveal Jekyll](https://github.com/sylhare/Reveal-Jekyll/blob/master/LICENSE) MIT licensed
|
|
81
103
|
|
|
82
104
|
Copyright (c) 2019 Sylhare \o/
|
|
83
105
|
|
|
84
|
-
|
|
106
|
+
### Reveal.js
|
|
85
107
|
|
|
86
108
|
[Reveal.js](https://github.com/hakimel/reveal.js/) MIT licensed
|
|
87
109
|
|
|
88
110
|
Copyright (C) 2019 Hakim El Hattab, http://hakim.se
|
|
89
111
|
|
|
90
|
-
|
|
112
|
+
### Jekyll
|
|
91
113
|
|
|
92
114
|
[Jekyll](https://github.com/jekyll/jekyll) MIT licensed
|
|
93
115
|
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: reveal-jekyll
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- sylhare
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2020-01-17 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -30,26 +30,6 @@ dependencies:
|
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: '5.0'
|
|
33
|
-
- !ruby/object:Gem::Dependency
|
|
34
|
-
name: bundler
|
|
35
|
-
requirement: !ruby/object:Gem::Requirement
|
|
36
|
-
requirements:
|
|
37
|
-
- - ">="
|
|
38
|
-
- !ruby/object:Gem::Version
|
|
39
|
-
version: '2.0'
|
|
40
|
-
- - "<"
|
|
41
|
-
- !ruby/object:Gem::Version
|
|
42
|
-
version: 2.1.0
|
|
43
|
-
type: :development
|
|
44
|
-
prerelease: false
|
|
45
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
46
|
-
requirements:
|
|
47
|
-
- - ">="
|
|
48
|
-
- !ruby/object:Gem::Version
|
|
49
|
-
version: '2.0'
|
|
50
|
-
- - "<"
|
|
51
|
-
- !ruby/object:Gem::Version
|
|
52
|
-
version: 2.1.0
|
|
53
33
|
description: Reveal.js Web presentation served with jekyll
|
|
54
34
|
email:
|
|
55
35
|
- sylhare@outlook.com
|