Skip to content

Instantly share code, notes, and snippets.

@jdan
Created October 7, 2012 04:39
Show Gist options
  • Save jdan/3847121 to your computer and use it in GitHub Desktop.
Save jdan/3847121 to your computer and use it in GitHub Desktop.
Cleaver - an easy tool to generate HTML slideshows from JSON
{
"name": "Cleaver",
"author": {
"name": "Jordan Scales",
"twitter": "@prezjordan",
"url": "http://jscal.es"
},
"description": "Hello World example!",
"slides": [
{
"type": "main",
"title": "cleaver",
"subtitle": "the simple way to generate static HTML slideshows"
},
{
"type": "text",
"title": "What is Cleaver?",
"content":
"**Cleaver** is the simplest way to generate interactive HTML presentations from simple JSON.>>
Get it from [npm](http://npmjs.org): `npm install -g cleaver`>>
One command turns a few lines of JSON into a beautiful slideshow. No coding necessary.>>
`cleaver --file=path/to/something.json`"
},
{
"type": "text",
"title": "Example",
"content":
"<pre>{<br />
\"name\": \"Example\",<br />
\"author\": {<br />
\"name\": \"Aaron Patterson\",<br />
\"twitter\": \"@tenderlove\",<br />
\"url\": \"http://tenderlovemaking.com\"<br />
},<br />
\"slides\": [<br />
{<br />
\"type\": \"main\",<br />
\"title\": \"Cleaver 101\",<br />
\"subtitle\": \"A first look at quick HTML presentations\"<br />
}<br />
]<br />
}</pre>"
},
{
"type": "list",
"title": "Slide Types",
"items": [
"main - just a big ol' title and subtitle",
"text - a simple text slide with a title and markdown content",
"list - basic list with a title and items (an array of strings)",
"author - automatically placed at the end of your presentation based on author in your JSON"
]
},
{
"type": "text",
"title": "Code",
"content":
"The source code to **cleaver** is freely
available [on GitHub](http://github.com/prezjordan/cleaver).
>>
If you're curious to see the code used
to generate these slides,
[here's a gist](https://gist.github.com/3847121).>>
Also available as `examples/helloworld.json`.>>
**Cleaver** is [MIT Licensed]((https://github.com/prezjordan/cleaver/blob/master/LICENSE)."
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment