This is a boilerplate to use Reveal.JS easily with Gulp, Jade and Stylus.
To know more about Reveal.js and how to use, read the docs here.
First of all, install the dependencies to run this boilerplate.
# Clone this repository
$ git clone git://github.com/willianjusten/reveal-boilerplate.git new_project
$ cd new_project
# install dependencies
$ npm install
# run tasks and serve
$ gulp
With the commands above, you have everything to start.
new_project -
/build -
/css
main.css
/js
/vendor
main.js
index.html
/src -
/js
/slides
/styl
/styl
/templates
gulpfile.js
package.json
/tests -
/unit
-
Write your slides in
src/slides
folder in separated files using the jade syntax and add them ontemplates/index.jade
. -
If you want to add another scripts and css use the
templates/inc/
folder and call them in thetemplates/index.jade
.
gulp
: Initialize watch for changes and a server(localhost:3000)gulp js
: execute js filesgulp notes
: copy speaker notesgulp stylus
: compile stylus filesgulp imagemin
:compress image filesgulp watch
: call for watch filesgulp jade
: compile jade filesgulp deploy-pages
: deploy compiled files atbuild
togithub
on branchgh-pages
.gulp deploy-src
: deploy compiled files atbuild
togithub pages
on branchmaster
.