Automagically create a slideshow from a markdown source file.
JavaScript CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
css
js
lib
themes
.gitignore
LICENSE
README.md
package.json

README.md

PrezDown

Automagically transform a markdown file into a slideshow.

Installation

$ (sudo) npm install -g prezdown

Usage

Create a Markdown file.

To create multiple slides, put an horizontal line (using at least 3 dash signs). The horizontal line must be on its own line, with an empty line before and after.

Example:

Page 1
======

This will be the first page

------------------------------

Page 2
======

This will be the second page

Run the script

$ prezdown somefile.md

Get the output

The resulting html file and the required assets will be placed in the output directory.

Options

--change [mode]

Set how slides should change (auto, keyboard, both).
By default, or if the mode is set to something other than `auto` or `keyboard`, both methods are used.

--clean

Do not compile, just remove the output directory.
Clean is always performed before a build.

--theme [name]

Choose the theme. A theme is simply a CSS file inside the themes directory.
The file name must be in the format <name>.min.css

--timeout [ms]

Set the number of milliseconds to wait before slide changes.
By default, the value is 5000ms (5s).

--title [title]

Choose the title of the slideshow. This is used in the <title> of the output

Assets

You can add images or other files in the assets directory. The directory must be in the same folder as the markdown file. Place the files in assets, without further subdirectories.

All the files in the assets directory will be copied into the output folder when building.

Libraries

The final HTML page will use the following libraries: