自由なエディタでMarkdownを書いてスライドを作成できるmarp-cli

2023/08/19 00:02

公開

Marp marp-cli

Marpというツールを使うと、Markdownでスライドを作成できます。
MarpはVSCodeの拡張機能としても提供されていますが、marp-cliを使うと、自由なエディタでMarkdownを書いてスライドを作成できます。

インストール方法

パッケージマネージャーを使用する場合 macOSでは

brew install marp-cli

Windowsでは

scoop install marp

でインストールできます。

npmを使用してローカルインストールする方法やスタンドアローンバイナリを使用する方法もあるのでそちらの方が好みの場合はmarp-cliのREADMEを参照してください。

marp slide-deck.md

でslide-deck.mdからslide-deck.htmlというファイルに変換できます。 -oオプションで出力先を指定できます。以下のコマンドではoutput.htmlというファイルに変換できます。

marp slide.md -o output.output.html

marp --pdf slide-deck.md # slide-deck.pdfに変換
marp slide-deck.md -o converted.pdf # convereted.pdfに変換

パワーポイント形式のファイルにも変換できます。

marp --pptx slide-deck.md # slide-deck.pptxに変換
marp slide-deck.md -o converted.pptx # convereted.pptxに変換

--imagesオプションを使用するとPNG/JPEGファイルに変換できます。

# 複数のPNGファイルに変換
marp --images png slide-deck.md

# 複数のJPEGファイルに変換
marp --images jpeg slide-deck.md

slide-deck.pp1.png, slide-deck.002.pngのようなファイルが生成されます。

--watch/-wオプションを使用すると、ファイルを監視して変更があった場合に自動で変換してくれます。下記のコマンドを実行すると、slide-deck.mdを監視して変更があった場合に自動でslide-deck.htmlに変換してくれます。

marp slide-deck.md -w

--server/-ss`オプションを使用すると、ローカルサーバーを起動してスライドを表示してくれます。サーバーモードの場合の引数はディレクトリなので注意が必要です。

marp ./slides -s # ./slidesディレクトリをルートとしてサーバーを起動

--themeオプションを使用すると、スライドにcssを適用できます。

marp slide-deck.md --theme theme.css

--input-dir,-Iオプションを使用すると、ディレクトリ内の全てのMarkdownファイルに対して変換できます。

marp -I ./slides # ./slidesディレクトリ内の全てのMarkdownファイルを変換

この場合は--themeオプションなしでも./slides以下のテーマを使用することができます。

ほかにもオプションがあるので、詳しくはmarp-cliのREADMEやmarp --helpを参照してください。