Code Monkey home page Code Monkey logo

slides's Introduction

Reveal.js Boilerplate

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.

Getting Started

Installation

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

How to Use

  • Write your slides in src/slides folder in separated files using the jade syntax and add them on templates/index.jade.

  • If you want to add another scripts and css use the templates/inc/ folder and call them in the templates/index.jade.

Tasks

  • gulp: Initialize watch for changes and a server(localhost:3000)
  • gulp js: execute js files
  • gulp notes: copy speaker notes
  • gulp stylus: compile stylus files
  • gulp imagemin:compress image files
  • gulp watch: call for watch files
  • gulp jade: compile jade files
  • gulp deploy-pages: deploy compiled files at build to github on branch gh-pages.
  • gulp deploy-src: deploy compiled files at build to github pages on branch master.

slides's People

Contributors

douglashennrich avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.