marp-team/marp-core

@marp-team/marp-core

The core of the Marp converter.

Marp Core extends the Marpit framework with practical Markdown syntax, advanced features, official themes, and optional core plugins.

[!IMPORTANT]

⚡️ Release Candidate: Marp Core v5 is currently a release candidate, and this README documents v5. Current Marp tools may still use stable v4; see the v4 branch for v4 documentation.

Install

Marp Core v5 supports Node.js 20.19 or later, but we highly recommend using an actively supported Node.js version.

npm install --save @marp-team/marp-core@next

Entrypoints

Since v5, Marp Core has been split into a lightweight core and optional core plugins.

*: Rough estimates for a minified browser ESM build before gzip. The full entrypoint includes all optional dependencies.

The full build provides a consistent experience across the Marp toolchain. For your own application, we recommend the lightweight core with only the plugins you need.

About the @marp-team/marp-core/browser entrypoint, see the browser helper.

Core plugins

Marp Core also provides optional plugins for several core features. These often require additional dependencies along with Marp Core.

To use @marp-team/marp-core/full, install every optional dependency along with Marp Core:

npm install --save \
  @marp-team/marp-core@next \
  shiki \
  beautiful-mermaid \
  katex \
  @mathjax/src \
  @mathjax/mathjax-bbm-font-extension \
  @mathjax/mathjax-bboldx-font-extension \
  @mathjax/mathjax-dsfont-font-extension \
  @mathjax/mathjax-mhchem-font-extension

Usage

Marp Core provides the Marp class, inherited from Marpit, so its basic usage is the same as Marpit.

import { Marp } from '@marp-team/marp-core'

const marp = new Marp()
const { html, css } = marp.render('# Hello, marp-core!')

Use @marp-team/marp-core/full instead when you want the full build.

See the Marpit usage documentation for more details.

With plugins

Add optional core plugins selectively by chaining use().

import { Marp } from '@marp-team/marp-core'
import katexPlugin from '@marp-team/marp-core/plugins/katex'
import shikiPlugin from '@marp-team/marp-core/plugins/shiki'

const marp = new Marp().use(shikiPlugin()).use(katexPlugin())

You can also add any Marpit-compatible plugin.

Documentation

Choose the guide that matches what you want to do:

• Markdown features - Write slides with Marp Markdown
• Built-in themes - All about the official themes
• Theme authoring - Create a custom theme suitable for Marp
• Configuration - Integrate Marp Core into your project
• Migration from v4 to v5 - Changes in v5 and how to migrate

Contributing

Interested in contributing? See CONTRIBUTING.md and the common contribution guidelines for the Marp team.

Author

Managed by @marp-team.

• Yuki Hattori (@yhatt)

License

This package is released under the MIT License.