Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/timo-reymann/marp-gh-page-action

GitHub Action to build a marp repository and publish to github pages
https://github.com/timo-reymann/marp-gh-page-action

action actions deployment github-action github-actions github-pages marp

Last synced: 9 days ago
JSON representation

GitHub Action to build a marp repository and publish to github pages

Awesome Lists containing this project

README

        

# marp-gh-page-action
[![LICENSE](https://img.shields.io/github/license/timo-reymann/marp-gh-page-action)](https://github.com/timo-reymann/marp-gh-page-action/blob/main/LICENSE)





GitHub Action to build a marp repository and publish to github pages

## Required for usage

- You have one or no asset folder
- Export as HTML must be running
- GitHub Pages enabled for the repo
- One presentation per repo: `index.md`

## Usage

### with asset path, CNAME

```yaml
name: Build and Deploy
on: [push]
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: marp-gh-page
uses: timo-reymann/marp-gh-page-action@v1
with:
domain: your-cname.example.com
assets_path: images
```

### with no assets or CNAME

```yaml
name: Build and Deploy
on: [push]
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: marp-gh-page
uses: timo-reymann/marp-gh-page-action@v1
```