Marpit API

markdown/directives/parse

Source: parse.js:2

Instance Methods

parse(md: MarkdownIt, opts?: Object)

parse.js:24

Parse Marpit directives and store result to the slide token meta.

Marpit comment plugin and slide plugin requires already loaded to markdown-it instance.

Parameters

  • md (MarkdownIt) — markdown-it instance.
  • opts (Object, optional)
    • opts.frontMatter (boolean, optional, default: true) — Switch feature to support YAML front-matter. If true, you can use Jekyll style directive setting to the first page.