Marp

Install

This is a stub page!

There are two ways to use Marp, through a command-line interface (Marp CLI) or through a graphical user interface (VS Code extension). To start authoring presentations, you must install either the CLI or the VS Code exension.

Should I use the Marp CLI or Marp for VS Code?

Basic Comparison

Marp for VS CodeMarp CLI
EditorVS CodeAny editor
Live PreviewYesYes
Export MethodClick to exportCommand Line
Use Marp plugins?NoYes

Marp for VS Code

If you are not familiar with the command line, use the VS Code extension without hesitation! All of the basic Marp features are available in Marp for VS Code.

Even if you are CLI savvy, you may prefer to author presentations through Marp for VS Code. VS Code has many convenient features for authoring a slide deck, including Marp syntax completion and live preview.

Marp CLI

Using Marp CLI is suited for following:

  • Authoring Markdown and theme CSS with your favorite editor (such as vim)
  • Batch processing
  • Combination with other tools (through piping and redirection)
  • Continuous Integration (CI)
  • Server-side conversion
  • Set advanced configuration of Marp
  • Use Marp in Node.js project
  • Use Marp / Marpit / markdown-it plugins
  • Use the other Marpit flavored engine

Installing Marp for VS Code

  1. Install Visual Studio Code.
  2. Install the Marp for VS Code extension.
  3. Create and open a new Markdown file (with .md extension).
  4. Select the Toggle Marp feature for current Markdown command from the Marp icon in editor actions (toolbar). This command will add Marp to the front-matter of your Markdown file: 
    1. ---
    2. marp: true
    3. ---
  5. Open VS Code Markdown preview, and start writing your presentation!

Installing Marp CLI

Homebrew (macOS)

  1. brew install marp-cli

Scoop (Windows)

  1. scoop install marp

Node.js

If you have installed Node.js >= 12, you can try one-shot conversion without installing powered by npx (npm exec).

  1. npx @marp-team/marp-cli@latest markdown.md

Install to Node project

  1. npm install --save-dev @marp-team/marp-cli
  2. npx marp markdown.md
  1. yarn add --dev @marp-team/marp-cli
  2. yarn exec markdown.md

You can also install the marp command globally, but it is not recommended.

Standalone binary

➡️ Download the latest standalone binary from the GitHub release page...

Docker

➡️ Check out the overview of an official container in Docker Hub...