https://github.com/yefim/heaver

Haskell implementation of Cleaver
https://github.com/yefim/heaver

Last synced: about 9 hours ago
JSON representation

Haskell implementation of Cleaver

• Host: GitHub
• URL: https://github.com/yefim/heaver
• Owner: yefim
• Created: 2013-12-17T05:33:14.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2013-12-20T07:47:26.000Z (almost 11 years ago)
• Last Synced: 2024-04-18T14:18:28.259Z (7 months ago)
• Language: Haskell
• Size: 8.5 MB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
progress: true

controls: true

encoding: utf-8

title: README

--

# Heaver

## inspired by Cleaver

## Thirty second Slideshows for Hackers

--

### Quick Start

Compile the binary:

`make`

And run it like so:

`./heaver path/to/file.md`

--

### Options

    title: Basic Example

    author:

      name: Geoffrey Vedernikoff

      twitter: yefim

      url: http://yef.im

    output: basic.html

    progress: true

    controls: true

    encoding: utf-8

Heaver supports several basic options that allow you to further customize the look and feel of your presentation, including author info, progress bar, and arrow controls.

--

### Overview

* `Main.hs` is the most important file. The `main` function in `Main.hs` runs whenever Heaver is called. `main` reads the Markdown file, slices it up into slides, renders the author slide, renders the other slides, and outputs them into a slideshow.

* `OurStache.hs` is the Mustache-subset parser which powers the templates. It has four main components:

    - Context - the Map which stores the variable state

    - Expr - the AST intermediate state

    - stacheP - the parser which turns a string into an Expr

    - pp - the printer which turns an Expr and a Context into a String

--

### Dependencies

* [HUnit](http://hackage.haskell.org/package/HUnit-1.2.5.1)

* [split](http://hackage.haskell.org/package/split-0.2.1.1)

* [pandoc](http://hackage.haskell.org/package/pandoc-1.12.2.1)

* [yaml-light](http://hackage.haskell.org/package/yaml-light-0.1.4)

--

### Contributors

* Lewis Ellis (ellisl)

* Geoffrey Vedernikoff (veg)