About Marp CLI Action

Marp CLI Action is...

a GitHub Action to convert markdown files into static HTML / CSS, PDF, PowerPoint document, and image(s) by Marp CLI.

This action can invoke Marp cli and generate HTML, PDF, PowerPoint and images from Markdown files in the repository.

What is "Marp"?

Marp is a tool to create slide deck with Markdown.

This slide deck is written in Markdown and converted by Marp CLI.

Markdown example

---
marp: true
paginate: true
---

<!-- _paginate: false -->

# About [Marp CLI Action](https://github.com/KoharaKazuya/marp-cli-action) <!-- fit -->

---

## [Marp CLI Action](https://github.com/KoharaKazuya/marp-cli-action) is...

See the source of this slide.

What does "Marp CLI Action" provide?

To run Marp CLI as a GitHub Action.

You can quickly and easily setup automation to generate HTML, PDF, PowerPoint and images from Markdown files in the repository.

How to use

1. Add this to your workflow

- uses: KoharaKazuya/marp-cli-action@v1

or

1. Use this template and create your repository
2. Write Marp markdown
3. Commit and push

Marp CLI Action does only generation files from Markdown. If you want to upload, release or publish, you can use any other actions.

Options

See the inputs section in action.yml.

To customize Marp CLI, use the Marp CLI configuration file such as marp.config.json, marp.config.cjs and .marprc.

The configuration file may be in repository root directory or specified by config-file input.

For Japanese users; Specify lang: ja-JP as Marp CLI option. If you do so, Marp CLI Action will fix CJK font problem.

Enjoy writing slides!