Theme

Marpit theme class.

Create a Theme instance.

You should use Theme.fromCSS unless there is some particular reason.

Parameters:
NameTypeDescription
namestring

The name of theme.

cssstring

The content of CSS.

Source

Members

css :string

The content of theme CSS.

Type:
  • string
Source

height :string

Slide height. It requires the absolute unit supported in CSS.

Type:
  • string
Source

(readonly) heightPixel :number

The converted height into pixel.

Type:
  • number
Source

importRules :Array.<module:postcss/import/parse~ImportMeta>

Parsed @import rules.

Type:
Source

meta :Object

Parsed metadata from CSS comments.

Type:
  • Object
Source

name :string

The name of theme.

Type:
  • string
Source

width :string

Slide width. It requires the absolute unit supported in CSS.

Type:
  • string
Source

(readonly) widthPixel :number

The converted width into pixel.

Type:
  • number
Source

Methods

(static) fromCSS(cssString, optsopt)

Create a Theme instance from Marpit theme CSS.

Parameters:
NameTypeAttributesDescription
cssStringstring

The string of Marpit theme CSS. It requires @theme meta comment.

optsObject<optional>
Properties
NameTypeAttributesDescription
metaTypeObject<optional>

An object for defined types for metadata.

Source