1.4.0 • Published 9 years ago
generator-code-deck v1.4.0
Code Deck is a Yeoman generator for creating code-based slideshow presentations. It was built because HTML slideshows are awesome, but they take too long to make. With Code Deck, your project is automatically set up so you can focus on presenting great content.
Intro Video
View full screencast on Youtube
Example
See an example of a presentation built with Code Deck.
Instructions
Generate:
- Once you have the "Prerequistes" installed, run
npm install -g generator-code-deck
to install the Code Deck Yeoman generator. cd
to the directory where you want to generate your presentation.- Run
yo code-deck
and answer the prompts.
Develop:
- Replace
src/images/logo.png
with your own logo. - Run
grunt serve
. - Edit the data in
src/data.js
Refer to the RevealJS documentation for more options.
Prerequisites
Before using Code Deck, you need to install a few things if you don't have them already...
- Node: download
- Bower:
npm install -g bower
. - Yeoman:
npm install -g yo
. - Grunt:
npm install -g grunt-cli
. - Sass:
gem install sass
.
If you run into any problems, you may need to use the sudo
command or reclaim ownership of your .npm
directory.
Features
- Yeoman generator for automatic customized presentation setup.
- RevealJS for slide animations and functionality.
- Grunt tasks for easy development and a shareable
dist
folder. - BrowserSync for live style and content injections during development.
- Sass variables for easy branding/theming.
- Handlebars templates for automatic slide creation from the data in
src/data.js
. - HighlightJS for easy code syntax highlighting inside of
<pre><code>
blocks.
Changelog
1.3.0
- Yeoman templates now include user's GitHub data out-of-the-box.
- Added a screencast tutorial.
- Added an example.
- Providing example slide content in
src/data.js
. - Cleaning up and updating README.
1.2.0
- Moving all content to the
data
object indata.js
for easier editing.
1.1.0
- Creating a
section
template which is re-used for eachsection
object indata.js
.
1.0.0
- Public release
Built with ♡ by @trevordmiller.