https://github.com/egonSchiele/mdpress

[DEAD] Make impress.js presentations from markdown files.
https://github.com/egonSchiele/mdpress

Last synced: 18 days ago
JSON representation

[DEAD] Make impress.js presentations from markdown files.

• Host: GitHub
• URL: https://github.com/egonSchiele/mdpress
• Owner: egonSchiele
• License: mit
• Archived: true
• Created: 2012-03-05T21:47:48.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2015-06-03T01:03:47.000Z (over 9 years ago)
• Last Synced: 2024-09-19T12:36:50.361Z (about 2 months ago)
• Language: CSS
• Homepage: http://egonschiele.github.io/mdpress/
• Size: 518 KB
• Stars: 337
• Watchers: 22
• Forks: 49
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mdpress

**This project is looking for a new maintainer!** If you are interested, please send me a message. In the meantime, I will continue accepting merge requests but I won't be fixing bugs.

This is a tool that converts markdown files to presentations using [impress.js](https://github.com/bartaz/impress.js/).

# Example

[This presentation](http://static.adit.io/mdpress/default) was created from [this markdown file](https://raw.github.com/egonSchiele/mdpress/master/examples/demo.md).

[This presentation](http://static.adit.io/mdpress/obtvse) 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](http://code.google.com/p/google-code-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](http://egonschiele.github.io/mdpress/) (it's easy!).

## Mdpress in the wild

- There's a [debian package](http://packages.qa.debian.org/m/mdpress.html) available.

- Here's a [Yeoman generator](https://github.com/btholt/generator-mdpress) for mdpress.

## Contributors

- [Mte90](https://github.com/Mte90)

- [linopolus](https://github.com/linopolus)

- [kmlawson](https://github.com/kmlawson)

- [guidokessels](https://github.com/guidokessels)

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