https://github.com/moedevelops/marp-github-pages-template

github-pages markdown marp marpit presentation presentation-slides slides template

Last synced: 5 days ago
JSON representation

A templeate for Marp Presentations on GitHub Pages

Host: GitHub
URL: https://github.com/moedevelops/marp-github-pages-template
Owner: MoeDevelops
License: mit
Created: 2025-02-28T18:03:36.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2025-02-28T18:03:37.000Z (over 1 year ago)
Last Synced: 2025-03-03T05:32:46.549Z (over 1 year ago)
Topics: github-pages, markdown, marp, marpit, presentation, presentation-slides, slides, template
Language: Markdown
Homepage: https://moedevelops.github.io/marp-github-pages-template/
Size: 1.95 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

README

# 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:

```sh
npm i @marp-team/marp-cli
```

Add the following build script:

```sh
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`