Marpit

Marpit

Parse Marpit Markdown and render to the slide HTML/CSS.

Constructor

new Marpit(optsopt)

Create a Marpit instance.

Source:
Parameters:
Name Type Attributes Description
opts Object <optional>
Name Type Attributes Default Description
anchor boolean | Marpit~AnchorCallback <optional>
 true

Set the page number as anchor of each slides (id attribute). You can customize the anchor text by defining a custom callback function.
container false | Element | Array.<Element> <optional>
 module:element.marpitContainer

Container element(s) wrapping whole slide deck.
headingDivider false | number | Array.<number> <optional>
 false

Start a new slide page at before of headings. it would apply to headings whose larger than or equal to the specified level if a number is given, or ONLY specified levels if a number array.
looseYAML boolean <optional>
 false

Allow loose YAML parsing in built-in directives, and custom directives defined in current instance.
markdown MarkdownIt | string | Object | Array <optional>

An instance of markdown-it or its constructor option(s) for wrapping. Marpit will create its instance based on CommonMark when omitted.
printable boolean <optional>
 true

Make style printable to PDF.
slideContainer false | Element | Array.<Element> <optional>

Container element(s) wrapping each slide sections.
inlineSVG boolean | Marpit~InlineSVGOptions <optional>
 false

Wrap each slide sections by inline SVG. (Experimental)

Members

(readonly) customDirectives :Object

Definitions of the custom directive.

It has the assignable global and local object. They have consisted of the directive name as a key, and parser function as a value. The parser should return the validated object for updating meta of markdown-it token.

Source:
Type:
  • Object

markdown :MarkdownIt

Source:
Type:
  • MarkdownIt

(readonly) options :Object

The current options for this instance.

This property is read-only and marked as immutable. You cannot change the value of options after creating instance.

Source:
Type:
  • Object

themeSet :ThemeSet

Source:
Type:

Methods

render(markdown, envopt) → {Marpit~RenderResult}

Render Markdown into HTML and CSS string.

Source:
Parameters:
Name Type Attributes Default Description
markdown string

A Markdown string.
env Object <optional>
 {}

Environment object for passing to markdown-it.

Name Type Attributes Default Description
htmlAsArray boolean <optional>
 false

Output rendered HTML as array per slide.
Returns:
Type:
Marpit~RenderResult

An object of rendering result.

use(plugin, …params) → {Marpit}

Load the specified markdown-it plugin with given parameters.

Source:
Parameters:
Name Type Attributes Description
plugin function

markdown-it plugin.
params * <repeatable>

Params to pass into plugin.
Returns:
Type:
Marpit

The called Marpit instance for chainable.

Type Definitions

AnchorCallback(index) → {string}

Convert slide page index into anchor string.

Source:
Parameters:
Name Type Description
index number

Slide page index, beginning from zero.
Returns:
Type:
string

The text of anchor for id attribute, without prefix #.

InlineSVGOptions

Properties:
Name Type Attributes Default Description
enabled boolean <optional>
 true

Whether inline SVG mode is enabled.
backdropSelector boolean <optional>
 true

Whether ::backdrop selector support is enabled. If enabled, the ::backdrop CSS selector will match to the SVG container element.
Source:
Type:
  • Object

RenderResult

Properties:
Name Type Description
html string | Array.<string>

Rendered HTML.
css string

Rendered CSS.
comments Array.<Array.<string>>

Parsed HTML comments per slide pages, excepted YAML for directives. It would be useful for presenter notes.
Source:
Type:
  • Object