com.eden.orchid.presentations.PresentationsGenerator


Own Options

Type Default Value Description
baseDir String presentations The base directory in local resources to look for presentation slides in.

Inherited Options

Type Default Value Description
allData Map {} All options passed to this object.
layout String empty string Set the default layout to be used for all Pages from this Generator. Pages can specify their own layouts, which take precedence over the Generator layout.
parallel boolean false Improve site generation performance dramatically by rendering the pages from this Generator in parallel. There are currently thread-safety issues that may cause deadlocks, especially when in `serve` mode when build cycles may be executed multiple times. As such this feature should be considered highly experimental and used with caution.
theme Object null Set a theme to be used only when rendering pages from this Generator. This can be a String to use that theme's default options set in `config.yml`, or an object with a `key` property to use those specific options for the theme.

com.eden.orchid.presentations.components.PresentationComponent


Own Options

Type Default Value Description
deckTheme String web-2_0 The Deck.js presentation theme to use. Should be one of ['neon', 'swiss', 'web-2_0']
presentation Presentation null The key of the Presentation to display.
scriptsOnly boolean false If true, only include the Deck.js Javascript files, opting to build the styles yourself.
transitionTheme String horizontal-slide The Deck.js transition theme to use. Should be one of ['fade', 'horizontal-slide', 'vertical-slide']

Inherited Options

Type Default Value Description
allData Map {} All options passed to this object.
extraCss String[] empty array Add extra CSS files to the page containing this Component, which will be compiled just like the rest of the site's assets.
extraJs String[] empty array Add extra Javascript files to the page containing this Component, which will be compiled just like the rest of the site's assets.
hidden boolean false When true, this component will not have a template rendered on the page. Useful for Components that only add extra CSS or JS, or for temporarily removing a component from the page.
noWrapper boolean false When true, this component will not be wrapped in a wrapper element. The wrapper element is determinedby the theme, and it is up to the theme to ensure this is implemented properly.
order int 0 By default, components are rendered in the order in which they are declared, but the ordering can be changed by setting the order on any individual component. A higher value for order will render that component earlier in the list.
template String[] empty array Specify a template or a list of templates to use when rendering this component. The first template that exists will be chosen for this component.