Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Make impress.js presentations from markdown files.

branch: master
README.md

mdpress

This is a tool that converts markdown files to presentations using impress.js.

Example

This presentation was created from this markdown file.

This presentation was created from the same markdown file and a different stylesheet using mdpress -s [stylesheet name].

Advantages

  • dead simple, works with any markdown file
  • comes with a beautiful default stylesheet + more styles (more styles TBD) ... no need to write your own
  • ...but you can write your own easily if you want!
  • comes with prettify integrated, does code highlighting out of the box
  • has an auto-update mode; update your markdown file and mdpress will update your presentation automatically
  • quick install as a ruby gem
  • presentations are tiny and easy to distribute
  • presentations are easy to read as a plain text file

Install

gem install mdpress

Usage

  mdpress [url or filename.md]

This creates a directory named filename. Start the presentation by opening up index.html.

See full usage (it's easy!).

Mdpress in the wild

Contributing

To contribute a new stylesheet, follow these steps:

  1. Fork this repo.
  2. Place your new stylesheet in lib/impress_css/[your stylesheet name].css
  3. Send me a pull request!

Contributors

Copyright (C) 2013 by Aditya Bhargava (MIT license)

Something went wrong with that request. Please try again.