API Documentation

class premark.presentation.Presentation(source: Optional[Union[str, pathlib.Path, premark.utils.Readable]] = None, markdown: Optional[str] = None, remark_args: Optional[dict[str, Union[str, bool]]] = None, html_template: Optional[Union[str, pathlib.Path, premark.utils.Readable]] = None, stylesheet: Optional[Union[str, pathlib.Path, premark.utils.Readable]] = None, title: Optional[str] = None, config_file: Optional[Union[str, pathlib.Path, premark.utils.Readable]] = None)[source]

A RemarkJS presentation.

classmethod from_presentations(presentations: Iterable[premark.presentation.Presentation]) premark.presentation.Presentation[source]

Create a single presentations by merging others together.

Parameters

presentations – An iterable of Presentation objects

Returns

The resulting, merged presentation

Return type

Presentation

to_html() str[source]

Convert the presentation to HTML.

Returns

An HTML rendering of the presentation.

Return type

str