画像

画像フィールド

画像ファイルのアップロード用フィールドです。サムネイル、アイキャッチ画像、アバターなどに使用します。

基本例

{
	"name": "thumbnail",
	"type": "image",
	"label": "サムネイル"
}

プロパティ

プロパティ必須説明
namestringYesフィールドの識別子
type"image"Yes"image"を指定
labelstringNoCMS上での表示名
notestringNo編集者向けの補足メモ
requiredbooleanNo必須フィールドかどうか
options.maxSizeBytesnumberNo最大ファイルサイズ(バイト、上限10MB)

使用例

サムネイル

{
	"name": "thumbnail",
	"type": "image",
	"label": "サムネイル",
	"required": true
}

アバター

{
	"name": "avatar",
	"type": "image",
	"label": "アバター",
	"note": "正方形の画像を推奨"
}

ファイルサイズ制限

画像ストレージの種類によって、アップロード可能な最大ファイルサイズが異なります。

ストレージデフォルト最大(maxSizeBytes指定時)
GitHub(リポジトリ)1MB1MB(変更不可)
Cloudflare R25MB10MB
Cloudinary5MB10MB

maxSizeBytesオプション

R2/Cloudinaryを使用している場合、options.maxSizeBytesで最大10MBまでファイルサイズ制限を拡張できます。

{
	"name": "highResImage",
	"type": "image",
	"label": "高解像度画像",
	"options": {
		"maxSizeBytes": 10485760 // 10MB(10 * 1024 * 1024)
	}
}
GitHubストレージを使用している場合、maxSizeBytesは無視され、常に1MBが上限となります。

許可されているファイル形式

以下の5つの形式がサポートされています。

MIMEタイプ拡張子説明
image/jpeg.jpg, .jpegJPEG画像
image/png.pngPNG画像
image/gif.gifGIF画像
image/webp.webpWebP画像
image/svg+xml.svgSVG画像

保存形式

画像のURLが文字列として保存されます。

マークダウン形式:

---
thumbnail: 'https://example.com/images/thumbnail.jpg'
---

JSON形式:

{
	"thumbnail": "https://example.com/images/thumbnail.jpg"
}