Marp CLI Action について

Marp CLI Action とは...

@marp-team/marp-cli を用いて Markdown ファイルを静的な HTML / CSS、PDF、PowerPoint ドキュメント、画像などに変換する GitHub Action です。

このアクションは Marp CLI を実行し、HTML、PDF、PowerPoint、画像をレポジトリ内の Markdown ファイルから生成することができます。

"Marp" って？

Marp は Markdown でスライドを作るためのツールです。

このスライドは Markdown で書かれ、Marp CLI で変換されています。

Markdown 例

---
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...

このスライドのソース を参照してください。

"Marp CLI Action" は何を提供するの？

GitHub Action として Marp CLI を実行します。

リポジトリ内の Markdown ファイルから HTML、PDF、PowerPoint、画像を生成の自動化を素早く簡単にセットアップできます。

使い方

1. ワークフローに以下を追加します

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

または

1. このテンプレート を使用し、リポジトリを作成します
2. Marp の Markdown を書きます
3. コミットし、プッシュします

Marp CLI Action は Markdown からファイルを生成するのみです。アップロード、リリース、公開などをしたい場合は他のアクションを使いましょう。

オプション

action.yml の inputs セクションを参照してください。

Marp CLI をカスタマイズするには marp.config.json、marp.config.cjs、.marprc といった Marp CLI の設定ファイル を使用してください。

設定ファイルはリポジトリルートに置くか、config-file input を指定します。

日本語ユーザーへ; Marp CLI オプションとして lang: ja-JP を指定してください。そうした場合、Marp CLI Action は CJK フォント問題を修正します。

楽しくスライドを書こう！