You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-3Lines changed: 13 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,13 @@ I wanted to show a small gallery inside a reveal.js presentation (slideshow with
4
4
5
5
## Installing
6
6
7
-
* copy `gallery.js` to `plugins/gallery/gallery.js` in your reveal.js presentation
7
+
* copy `gallery.plugin.js` to `plugins/gallery/gallery.plugin.js` in your reveal.js presentation
8
8
* copy `gallery.css` to `plugins/gallery/gallery.css` or integrate into your CSS your preferred way, customise the styles as required. You will need to set the width and height of the `.gallery` selector to match the natural size of your presentation defined in `reveal.js`
9
9
* add the following to the head of `index.html` after other stylesheets are loaded:
@@ -32,4 +32,14 @@ There's only really two configurable options at the moment, both set as data ele
32
32
***data-iterations** how many times to loop through the slideshow - default is once and stop on the last slide. Set
33
33
to 0 to repeat indefinitely
34
34
35
-
You can also customise how the labels will look by editing the `label` style in `gallery.css`.
35
+
You can also customise how the labels will look by editing the `label` style in `gallery.css`.
36
+
37
+
## Contributing
38
+
39
+
### Building
40
+
41
+
Just for kicks this codebase is a bit overengineered. The Reveal specific code has been split from the generic Gallery code to allow it to be tested. Gallery code is in `src/gallery.js`, Reveal plugin code is in `src/gallery.reveal.js`. To build a single JS file for use with Reveal there is a `Makefile` - so just run `make` in the root of the project and you'll get a `gallery.plugin.js`.
42
+
43
+
### Testing
44
+
45
+
Tests are browser based using Mocha & Chai, run these by running `tests/index.html`.
0 commit comments