ヘッダーテキスト

Marp

フッターテキスト
ヘッダーテキスト

概要

MarpはMarkdown形式でスライドを記述し、HTML/PDF/PPTXなどに変換できるツール。

本プロジェクトでの特徴:

  • MkDocsのページとしてWeb上で閲覧可能
  • PDF出力はMkDocsのto-pdfプラグインで統合的に行う
  • スライド単体のPDF出力も可能
フッターテキスト
ヘッダーテキスト

基本構文

スライドの区切り

スライドは---(水平線)で区切る。


# スライド1

最初のスライドの内容

---

# スライド2

2枚目のスライドの内容
フッターテキスト
ヘッダーテキスト

フロントマター

スライドの先頭にフロントマターを記述して設定を行う。

---
marp: true
theme: default
paginate: true
header: 'ヘッダーテキスト'
footer: 'フッターテキスト'
---
フッターテキスト
ヘッダーテキスト

主な設定項目:

設定 説明
marp: true Marpスライドとして認識させる
theme テーマ(default, gaia, uncover)
paginate ページ番号を表示
header ヘッダーテキスト
footer フッターテキスト
size スライドサイズ(16:9, 4:3)
フッターテキスト
ヘッダーテキスト

スタイリング

ディレクティブ

スライドごとにスタイルを変更できる。

---

<!-- _class: lead -->
# タイトルスライド

中央寄せのリードスライド

---
フッターテキスト
ヘッダーテキスト
<!-- _backgroundColor: #123 -->
<!-- _color: white -->
# 背景色を変更

このスライドは背景が暗い

---
フッターテキスト
ヘッダーテキスト

画像の配置


![width:300px](../assets/images/my-diagram.drawio.svg)

<!-- 背景画像として使用 -->
![bg right:40%](../assets/images/background.png)

画像の指定方法:

  • width:300px - 幅を指定
  • height:200px - 高さを指定
  • bg - 背景画像として使用
  • bg right:40% - 右側40%に背景画像
フッターテキスト
ヘッダーテキスト

VS Code拡張

Marp for VS Code拡張を使用すると、エディター内でプレビューを確認できる。

  1. VS Codeを開く
  2. 拡張機能で「Marp for VS Code」を検索
  3. インストール
フッターテキスト
ヘッダーテキスト

PDF出力

MkDocs統合でのPDF

MkDocsサイト全体をPDF化する場合は、to-pdfプラグインを使用する。

MKDOCS_PDF=1 uv run mkdocs build
フッターテキスト
ヘッダーテキスト

スライド単体のPDF

Marp CLIを使用してスライド単体をPDF化できる。

# Marp CLIのインストール
npm install -g @marp-team/marp-cli

# PDFに変換
marp slides.md --pdf
フッターテキスト
ヘッダーテキスト

HTMLに変換

marp slides.md --html
フッターテキスト
ヘッダーテキスト

参考リンク

フッターテキスト