Cleaver supports several basic options for adding a bit of customization to your presentations. These options are placed at the top of your document, in YAML format. A typical option setup resembles the following.
title: Basic Example author: name: Jordan Scales twitter: jdan url: http://jordanscales.com style: basic-styles.css output: basic.html
The title of the rendered document.
Several fields which, if included, populate a basic author "credits" slide at the end of your presentation.
These fields include:
- name: Your full name
- url: A url to your website
- twitter: Your twitter handle (weibo also supported)
- email: Your email address
Please note that some characters must be escaped. For example, "@username" would need to be wrapped in quotes. You can leave out the "@" when specifying a twitter handle.
For example, check out the retro theme.
For more information on themes, check out the documentation.
An optional stylesheet to load. This can be either a URL, or an absolute/relative path to a file. Relative to the markdown document you are sending to cleaver.
These styles will be appended to Cleaver's default style. For more fine-grained control, check out the docs on Theming.
The filename (or absolute/relative path to a file) you wish to save your output to.
An option determining whether or not you want to render simple navigation buttons on your presentation.
Displays a small progress bar at the top of your document.
Content encoding to use on the rendered document.
URL or path to a mustache template used to render the slides. See default.mustache for inspiration.
URL or path to a mustache template used to render the entire slideshow. See layout.mustache for inspiration.