https://github.com/btholt/generator-mdpress

A Yeoman generator for creating an mdpress presentation
https://github.com/btholt/generator-mdpress

Last synced: 10 months ago
JSON representation

A Yeoman generator for creating an mdpress presentation

• Host: GitHub
• URL: https://github.com/btholt/generator-mdpress
• Owner: btholt
• License: mit
• Created: 2013-05-15T15:43:52.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2013-05-17T05:24:43.000Z (about 13 years ago)
• Last Synced: 2025-08-28T15:54:33.302Z (10 months ago)
• Language: JavaScript
• Size: 132 KB
• Stars: 8
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Generator mdpress

[![Build Status](https://secure.travis-ci.org/btholt/generator-mdpress.png?branch=master)](https://travis-ci.org/btholt/generator-mdpress)

You'll need to install Aditya Bhargava's [mdpress](http://github.com/egonSchiele/mdpress) for this work.

mdpress is a ruby gem that allows you to create rad presentations using [impress.js](http://github.com/bartaz/impress.js) in simple and readable [markdown](http://daringfireball.net/projects/markdown/).

This generator allows you to scaffold up a presentation using Yeoman. In addition, it comes bundled with a JavaScript file that enforces [Ignite presentation guidelines](http://tinyurl.com/3lxmml) that will automatically advance the slides every 15 seconds and put it into fullscreen mode for you.

## New in 0.2.0

- [Gruntjs](http://gruntjs.com)! Now you can run grunt tasks to manage your presentation. The most useful being `grunt server` which will watch for changes, run mdpress to compile for you, and do livereload.

- Implemented underscore templating in the templates.

- Made package.json and bower.json more useful.

## Current Issues

- If you're using the ignite JS, you cannot open the presentation using the mdpress -r flag. It's because mdpress creates a temporary project and only copies select files to that temp directory. Instead use the grunt tasks provided.

## Getting started

- Make sure you have [yo](https://github.com/yeoman/yo) installed:

    `npm install -g yo`

- Install the generator **locally**: `npm install generator-mdpress`

- Run: `yo mdpress`

## Use

- To run presentation, enter `grunt server` in the terminal from the root of the project.

## Roadmap

- Split ignite JS into subgenerator.

- Add testing.

- Add multiple themes. Perhaps a Yeoman-specific theme.

## License

[MIT License](http://en.wikipedia.org/wiki/MIT_License)