README.md

Marp GitHub Pages Template

This template allows you to deploy your Marp Presentation via GitHub Pages

Setup

1. Click on Use this template and create a repository

2. Enable Pages: Settings > Pages > Source: Select GitHub Actions

3. Re-run the Deploy to GitHub Pages Action

Local building

Install marp cli:

npm i @marp-team/marp-cli

Add the following build script:

npx @marp-team/marp-cli --html index.md -o build/index.html --theme theme.css && cp -r assets/ build/ | true

VSCode extension

To preview your marp project you can use the VSCode extension.

Enable custom css in preview

Marp for VS Code exention > Settings > Markdown > Marp: Themes > Add item theme.css