フロントマター（frontmatter）

コンテンツファイルの先頭にあるYAMLのブロックで、タイトル、日付、タグ、公開範囲などの型付きメタデータに解析されます。slugとは独立にノートを識別する安定したidもここに置きます。

よく使うフィールド

解析

frontmatterはMarkdownの本文より先に解析されるため、フックと公開先の解決はメタデータを先に読めます。未知のフィールドはプラグイン用にそのまま残ります。

公開を決めるfrontmatterのフィールド

frontmatterには、ノートの公開方法を決める3つの安定したフィールドがあり、explicitとselectiveの公開戦略で共通です。

• publish：戦略がexplicitのときは、publish: trueのノートだけが公開されます。selectiveのときは無視されます。
• private：戦略がselectiveのときは、private: trueのノートが公開出力から除外されます。explicitのときは無視されます。
• draft：戦略がselectiveのときは、draft: trueのノートが公開出力から除外されます。explicitのときは無視されます。

公開の判定はpackages/core/src/types/publish_strategy.tsのisPublishable(strategy, frontmatter)が行います。

export function isPublishable(
  strategy: PublishStrategy,
  frontmatter: PublishFrontmatter | undefined,
): boolean {
  if (strategy === "explicit") {
    return frontmatter?.publish === true;
  }
  return !(frontmatter?.private === true || frontmatter?.draft === true);
}

PublishFrontmatter型は次のとおりです。

export type PublishFrontmatter = {
  readonly publish?: unknown;
  readonly private?: unknown;
  readonly draft?: unknown;
};

frontmatterの解析

frontmatterはMarkdownの本文より先に解析されるため、フックと公開先の解決はメタデータを先に読めます。未知のフィールドはプラグイン用にそのまま残ります。解析されたfrontmatterはPostFrontmatter型に格納され、ContentManifestEntry（packages/core/src/types/content_manifest.ts）のfrontmatterフィールドになります。resolvePublishingStateが公開状態を決めるのにも使われます。

// From packages/core/src/types/post_content.ts
export type PostFrontmatter = {
  title?: string;
  date?: string | Date;
  tags?: string[];
  series?: string;
  published?: boolean;
  visibility?: "public" | "unlisted" | "draft" | "scheduled";
  aliases?: string[];
  id?: string;
};

関連用語

• Page
• Publish Strategy