Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/binocarlos/pagemaker

merge together markdown with front-matter and a mustache template
https://github.com/binocarlos/pagemaker

Last synced: 10 days ago
JSON representation

merge together markdown with front-matter and a mustache template

Awesome Lists containing this project

README

        

pagemaker
=========

A module to combine the following modules into a 3d animating book created from [bookmaker](https://github.com/binocarlos/bookmaker) data.

* [pageturner](https://github.com/binocarlos/pageturner) for the 3d turning pages
* [bookbinding](https://github.com/binocarlos/bookbinding) for the book image background
* [pagehammer](https://github.com/binocarlos/pagehammer) for touch event page turning
* [pagenav](https://github.com/binocarlos/pagenav) for the navbar
* [pagearrows](https://github.com/binocarlos/pagearrows) for back/next arrows
* [pageshadow](https://github.com/binocarlos/pageshadow) for page shadows

## installation

```
$ component install binocarlos/pagemaker
```

## example

First have your HTML:

```html

```

Create a new book passing in [bookmaker](https://github.com/binocarlos/bookmaker) data:

```js
var PageMaker = require('pagemaker')
var data = {
title:"My Cool Book",
pages:[{
title:"Intro",
html:"

This is the first page

"
},
...]
}
var opts = {

}
var book = PageMaker(opts)

// load the page data
book.load(data)

// the book, nav and arrows are seperate elements you can append to your gui
book.appendTo('#mybook')
book.nav.appendTo('#navholder')
book.arrows.appendTo('#mybook')
```

## licence
MIT