yhatt / marp-cli-example

The good starter for using Marp via Marp CLI, by the author of Marp

Marp CLI example

The good starter example for using Marp via Marp CLI.

• Write your slide deck by Marp Markdown.
• Manage the content of slides via Git. (Using GitPitch style PITCHME.md)
• Host your deck at GitHub, and publish as webpage with GitHub Pages, Netlify, and Vercel.
• Blazingly fast delivery out of the box. Acquired all 100% Lighthouse scores!

See published slide deck

• GitHub Pages: https://yhatt.github.io/marp-cli-example
• Netlify: https://yhatt-marp-cli-example.netlify.app/
• Vercel: https://marp-cli-example.yhatt.vercel.app/

Lighthouse

Usage

It's surprisingly easy to start publishing your slide deck!

GitHub Pages

Create a new public repository based on this repository, from "Use this template" button!

We already have GitHub Actions workflow to build and deploy automatically when merged to master branch. It's also available to deploy from any branch manually.

To get started, turn on GitHub Pages in repository's "Settings tab → Pages" by setting source as "GitHub Actions".

Netlify

Push "Deploy to netlify" button. Netlify will create your repository based on this example and host website from master branch automatically.

Vercel

Push "Deploy" button. Vercel can choose to create your repository based on this example.

ℹ️ To enable the auto-generated open graph image in Vercel, you have to turn on "Automatically expose System Environment Variables" in your Vercel project dashboard.

How to write

For Marp slide deck features, please see the documentation of Marpit Markdown, the features of Marp Core, and the default example in PITCHME.md for .

You have to install Node.js and run npm i at first if you want to write slide deck with Marp CLI.

Edit deck

Just edit PITCHME.md!

Preview deck

Marp for VS Code extension is the best partner for writing Marp slide deck with live preview.

You can try edit and preview on the web now! Open https://github.dev/yhatt/marp-cli-example/blob/master/PITCHME.md or hit . key on this repository, and install Marp for VS Code extension.

Preview via CLI

npm run start

It will be opened preview window via installed Google Chrome, and track change of PITCHME.md.

Assets and themes

• assets directory can put your assets for using in the deck. (e.g. Image resources)
• themes directory can put custom theme CSS. To use in the deck, please change theme global directive.

Build deck via CLI

npm run build

The built assets will output to public folder.

Build per assets

npm run deck      # Output static HTML to public/index.html
npm run og-image  # Output image for Open Graph to public/og-image.jpg

LICENSE

WTFPL