Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Turn markdown files into html presentations you can share with dropbox (or S3, or...)
JavaScript HTML
Failed to load latest commit information.
assets/tpl
bin
help fix: Use default theme='black'
lib
test
.gitignore partial: Working-ish, prep for merge
.jshintrc
.npmignore partial: Working-ish, prep for merge
LICENSE-MIT
README.md
gruntfile.js ref: Remove bower files
package.json

README.md

Bedecked

Bedecked converts markdown files to portable html5 presentations. I'm open to adding support for other templating engines too, right bedecked also supports jade and vanilla html.

Inspired by hackynote, I wanted a simple way to build snazzy presentations from markdown files that I could export as a single HTML document. Pop those in your public dropbox folder (or S3, or whatever) and share.

Bedecked looks for consecutive empty lines in your source file to insert slide breaks, for example:

## My first slide

This will be on one slide


## My second slide

This will be on a new slide (notice the two empty lines above the heading)



### Another slide

More than two empty lines  is fine too.

Check out our gh-pages for a basic example. The corresponding markdown can be found there too.

Installation

Install bedecked globally to get access to the cli with:

npm install -g bedecked

You can also use bedecked api locally in your app:

npm install --save bedecked

Usage

CLI

After a global install you'll have access to the bedecked command:

bedecked [options] <file>

Where <file> is your markdown file. Your html presentation will be written to stdout so you'll most often be sending that directly to a file:

bedecked my_prez.md > my_prez.html

Bedecked has built in options to switch the presentation theme, templating engine, start a live reload server, and more. We're using reveal.js for presentations and all reveal configuration options can be set with the bedecked cli.

Run bedecked --help for more information on command line usage.

$HOME/.bedeckedrc

Using the same options over and over? Have a favorite theme? Bedecked will read options from $home/.bedeckedrc if it exists. The file should be in JSON format and can override any option listed here.

API

The bedecked module exports a single method:

var bedecked = require('bedecked')
  , presentationFile = 'path/to/my/prez.md'
  , opts = {
      engine: 'markdown', // markdown | jade | html
      theme: 'black', // See available themes http://www.cdnjs.com/libraries/reveal.js
      protocol: 'https:', // http: | https: | ''
      title: 'Just Another Bedecked Presentation',
      revealjsVersion: '3.0.0',

      // See https://github.com/hakimel/reveal.js#configuration
      optAutoSlide: 0,
      optAutoSlideStoppable: true,
      optCenter: true,
      optControls: true,
      optEmbedded: false,
      optFragments: true,
      optHideAddressBar: true,
      optHistory: false,
      optKeyboard: true,
      optLoop: false,
      optMouseWheel: false,
      optOverview: true,
      optPreviewLinks: false,
      optProgress: true,
      optRtl: false,
      optSlideNumber: false,
      optTouch: true,
      optViewDistance: 3
    };

// All options are optional ;) as is the opts parameter itself
bedecked(presentationFile, opts, function(err, html) {
  if(err) {
    // Whoops!
  }
  // Do something with HTML
});

Live Reloading

It would be a real pain to have to run bedecked whenever you wanted to see your latest changes. Bedecked ships with a live reload server to support interactive presentation development. Try bedecked --server my_prez.md or view bedecked help server for more information.

Testing

Test and lint with grunt.

Use grunt watch to run tests interactively.

Getting Help

Use the tag bedecked on Stack Overflow. For quick things I can be reached on twitter @jusrussell.

Changelog

  • v0.8.1 2015-02-19 Fix default theme
  • v0.8.0 2015-02-19 Use reveal.js@3.0.0
  • v0.6.0 2014-10-14 Switch to reveal.js for presentation framework. Add support for ~/.bedeckedrc config files.

License

MIT

Something went wrong with that request. Please try again.