npm

Need private packages and team management tools?Check out npm Orgs. »

@marp-team/marp-core

0.12.0 • Public • Published

@marp-team/marp-core

CircleCI Codecov npm LICENSE

The core of Marp converter.

In order to use on Marp tools, we have extended from the slide deck framework Marpit. You can use the practical Markdown syntax, advanced features, and official themes.

Basic usage

We provide Marp class, that is inherited from Marpit.

import Marp from '@marp-team/marp-core'
 
// Convert Markdown slide deck into HTML and CSS
const marp = new Marp()
const { html, css } = marp.render('# Hello, marp-core!')

Marp.ready()

Marp class has ready() static method to work several features correctly. It must run on the browser context by using Browserify or webpack.

import Marp from '@marp-team/marp-core'
 
document.addEventListener('DOMContentLoaded', () => {
  Marp.ready()
})

Separated bundle

We also provide a separated bundle lib/browser.js for browser context. It is useful when you cannot use bundler.

Loading lib/browser.js will bring the almost same result as running Marp.ready(). Thus, you could use it through CDN as below:

<html>
  <body>
    <!-- Please insert here rendered HTML by `Marp.render().html`... -->
 
    <script
      defer
      src="https://cdn.jsdelivr.net/npm/@marp-team/marp-core/lib/browser.js"
    ></script> 
  </body>
</html>

CommonJS bundle is also provided in lib/browser.cjs.js. It have to call manually as same as Marp.ready().

Features

We will only explain features extended in marp-core. Please refer to @marp-team/marpit repository if you want to know the basic feature of Marpit framework.

Marp Markdown

Marp Markdown is based on Marpit and CommonMark, and there are these additional features:

Built-in official themes

We provide bulit-in official themes for Marp. See more details in themes.

Default Gaia Uncover
<!-- theme: default --> <!-- theme: gaia --> <!-- theme: uncover -->

size global directive

Do you want a traditional 4:3 slide size? We've added the support of size global directive only for Marp Core (And keeping backward compatibility of syntax with the old Marp app too).

Our extended theming system can use 960x720 slide in built-in themes easier: size: 4:3.

---
theme: gaia
size: 4:3
---
 
A traditional 4:3 slide

If you want to use more size presets in your theme, you have to define @size metadata(s) in theme CSS. Learn in the document of theme metadata for Marp Core.

Theme author does not have to worry an unintended design being used with unexpected slide size because user only can use pre-defined presets by author.

Emoji support

Emoji shortcode (like :smile:) and Unicode emoji 😄 will convert into the SVG vector image provided by twemoji 😄. It could render emoji with high resolution.

Math typesetting

We have Pandoc's Markdown style math typesetting support by KaTeX. Surround your formula by $...$ to render math as inline, and $$...$$ to render as block.

Markdown Rendered slide
Render inline math such as $ax^2+bc+c$.
 
$$ I_{xx}=\int\int_Ry^2f(x,y)\cdot{}dydx $$
 
$$
f(x) = \int_{-\infty}^\infty
    \hat f(\xi)\,e^{2 \pi i \xi x}
    \,d\xi
$$

Math typesetting support

Auto-scaling features

Auto-scaling is available only if enabled Marpit's inlineSVG mode and defined @auto-scaling metadata in an using theme CSS. In addition, you have to run Marp.ready() on browser context.

/*
 * @theme enable-all-auto-scaling
 * @auto-scaling true
 */

Marp Core's scaling features will be realized by manipulating the original DOM to use inline SVG. So the theme author must take care of updated DOM in styling. Refer to the source code of offical themes.

@auto-scaling meta can also pick the favorite features to enable by using keyword(s).

/*
 * @theme enable-auto-scaling-for-fitting-header-and-math
 * @auto-scaling fittingHeader,math
 */

⚠️ In the math block and the code block, Marp Core won't detect whether they actually protrude from the slide. It might not work scaling correctly when there are many elements in a slide.

Fitting header

When the headings contains <!-- fit --> comment, the size of headings will resize to fit onto the slide size.

<!-- fit --> Fitting header

This syntax is similar to Deckset's [fit] keyword, but we use HTML comment to hide a fit keyword on Markdown rendered as document.

ℹ️ @auto-scaling fittingHeader is a keyword of the @auto-scaling meta to enable fitting header.

Math block

We can scale-down the viewing size of math block (surrounded by $$) to fit a slide automatically.

Traditional rendering Auto-scaling
Traditional rendering Auto-scaling

ℹ️ @auto-scaling math is a keyword of the @auto-scaling meta to enable math block scaling.

Code block

Several themes also can scale-down the viewing size of the code block to fit a slide.

Traditional rendering Auto-scaling
Traditional rendering Auto-scaling

These features means that the contents on a slide are not cropped, and not shown unnecessary scrollbars in code.

ℹ️ @auto-scaling code is a keyword of the @auto-scaling meta to enable code block scaling.

uncover theme has disabled code block scaling because we use elastic style that has not compatible with it.

Constructor options

You can customize a behavior of Marp parser by passing an options object to the constructor. You can also pass together with Marpit constructor options.

ℹ️ Marpit's markdown option is accepted only object options because of always using CommonMark.

const marp = new Marp({
  // marp-core constructor options
  html: true,
  emoji: {
    shortcode: true,
    unicode: false,
    twemoji: {
      base: '/resources/twemoji/',
    },
  },
  math: {
    katexFontPath: '/resources/fonts/',
  },
 
  // It can be included Marpit constructor options
  looseYAML: false,
  markdown: {
    breaks: false,
  },
})

html: boolean | object

Setting whether to render raw HTML in Markdown.

  • true: The all HTML will be allowed.
  • false: All HTML except supported in Marpit Markdown will be disallowed.
  • By passing object, you can set the whitelist to specify allowed tags and attributes.
// Specify tag name as key, and attributes to allow as string array.
{
  a: ['href', 'target'],
  br: [],
}
// You may use custom attribute sanitizer by passing object.
{
  img: {
    src: value => (value.startsWith('https://') ? value : '')
  }
}

Marp core allows only <br> tag by default, that is defined in Marp.html.

Whatever any option is selected, <!-- HTML comment --> is always parsed by Marpit for directives. When you are not disabled Marpit's inlineStyle option by false, <style> tags are parsed too for tweaking theme style.

ℹ️ html flag in markdown option cannot use because of overridden by this.

emoji: object

Setting about emoji conversions.

  • shortcode: boolean | "twemoji"

    • By setting false, it does not convert any emoji shortcodes.
    • By setting true, it converts emoji shortcodes into Unicode emoji. :dog: → 🐶
    • By setting "twemoji" string, it converts into twemoji vector image. :dog:🐶 (default)
  • unicode: boolean | "twemoji"

    • It can convert Unicode emoji into twemoji when setting "twemoji". 🐶 → 🐶 (default)
    • If you not want this aggressive conversion, please set false.
  • twemoji: object

For developers: When you setting unicode option as true, Markdown parser will convert Unicode emoji into tokens internally. The rendering result is same as in false.

math: boolean | object

Enable or disable math typesetting syntax. The default value is true.

You can modify KaTeX further settings by passing an object of sub-options.

  • katexOption: object

  • katexFontPath: string | false

    • By default, marp-core will use online web-font resources through jsDelivr CDN. You have to set path to fonts directory if you want to use local resources. If you set false, we will not manipulate the path (Use KaTeX's original path: fonts/KaTeX_***-***.woff2).

Contributing

Are you interested in contributing? Please see CONTRIBUTING.md.

Author

Managed by @marp-team.

License

This package releases under the MIT License.

install

npm i @marp-team/marp-core

Downloadsweekly downloads

254

version

0.12.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability