Search documentation...

フロントマターリファレンス

フロントマターは.vdxファイルの先頭にあるTOML形式のメタデータです。

構文

フロントマターは+++マーカーで囲みます:

+++
layout = "default"
title = "ページタイトル"
+++

# ページコンテンツ

必須フィールド

なし。すべてのフィールドは適切なデフォルトでオプションです。

利用可能なフィールド

layout

使用するレイアウトテンプレートを指定。

layout = "default"
説明
default サイドバー付き標準ドキュメントレイアウト
landing ランディングページレイアウト(ナビから除外)
カスタム layouts/ディレクトリの任意のレイアウトファイル

指定しない場合のデフォルト値は"default"です。

title

ページタイトル。以下で使用:

  • ブラウザタブ(`<

title>`)

  • ナビゲーションサイドバー
  • SEOメタタグ
title = "はじめに"

指定しない場合、ファイル名がフォールバックとして使用されます。

将来のフィールド

これらのフィールドは将来のバージョンで予定されています:

description

SEO用のページ説明。

description = "Veltのインストールと設定方法を学ぶ"

date

ブログ投稿の公開日。

date = 2024-01-15

draft

ページを下書きとしてマーク(ビルドから除外)。

draft = true

order

ナビゲーションでのカスタム順序。

order = 1