https://github.com/xtfer/harp-reveal

A Harp-based scaffold for building presentations using Reveal
https://github.com/xtfer/harp-reveal

Last synced: 13 days ago
JSON representation

A Harp-based scaffold for building presentations using Reveal

• Host: GitHub
• URL: https://github.com/xtfer/harp-reveal
• Owner: xtfer
• Created: 2014-11-05T03:03:09.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-11-05T03:48:34.000Z (about 10 years ago)
• Last Synced: 2023-03-11T14:05:59.604Z (over 1 year ago)
• Language: JavaScript
• Size: 459 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

## Requirements

This presentation package uses Harp to compile and serve your presentation.

You will need:

- Node >= 0.10

- NPM

To install Harp, which serves the presentation:

```

$ sudo npm install -g harp

```

## Configuration

Basic presentation configuration variables can be found in harp.js. This includes your project name, for example.

Slides can be edited directly in public/index.jade

## Authoring

To make authoring large presentations easier, slides are packaged into sections under the public/sections folder. Two sections are provided by default.

Adding or reordering sections can be done in sections/_data.js. The section file name should correspond to its key in that data file.

Individual sections are written using either Jade (as provided), EJS templates, or HTML. Jade has the advantage of being simple yet as powerful as regular HTML.

Markdown can be included in Jade by adding a :markdown section (though Jade is pretty simple by itself) e.g.

```

section

	:markdown

		## My Title

		

		Some content

```

## Running your presentation

To see your presentation, run the harp server.

```

$ harp server app

```

Your presentation should now be available at http://localhost:9000/.

## Compiling to run without Harp

To compile your presentation down down standard HTML, CSS and JavaScript:

``` 

$ harp compile

```