Adapter リファレンス

Adapter は、Makit の静的成果物を各ホスティングサービスへ合わせる設定ファイル、リダイレクト、ヘッダー、CI を生成します。Adapter は任意です。使わない場合は dist/ を任意の静的ホスティングへ配置できます。

# 使用するサービスの Adapter だけを開発依存関係に追加します
pnpm add -D @natsuneko-laboratory/makit-adapter-github-pages

Adapter は文字列ではなくファクトリー関数の戻り値を deployment.adapter に指定します。

import { defineConfig } from "@natsuneko-laboratory/makit";
import githubPages from "@natsuneko-laboratory/makit-adapter-github-pages";

export default defineConfig({
  title: "My Documentation",
  deployment: { adapter: githubPages() },
});

生成予定のファイルは pnpm exec makit check で確認し、生成だけを行うには pnpm exec makit adapter generate を実行します。トークンや秘密鍵を設定ファイルへ書かず、各サービスの環境変数または認証機構を使ってください。

共通の deployment 設定

Cloudflare Pages

pnpm add -D @natsuneko-laboratory/makit-adapter-cloudflare-pages

import cloudflarePages from "@natsuneko-laboratory/makit-adapter-cloudflare-pages";

export default defineConfig({
  title: "My Documentation",
  deployment: {
    adapter: cloudflarePages({
      projectName: "my-docs",
      generateWranglerConfig: true,
      redirects: { mode: "native" },
      headers: { enabled: true },
    }),
  },
});

Cloudflare Pages はネイティブなリダイレクトとカスタムヘッダーに対応します。

GitHub Pages

pnpm add -D @natsuneko-laboratory/makit-adapter-github-pages

import githubPages from "@natsuneko-laboratory/makit-adapter-github-pages";

export default defineConfig({
  title: "My Documentation",
  deployment: {
    adapter: githubPages({
      repository: "owner/docs",
      siteType: "project",
      basePath: "auto",
      generateWorkflow: true,
      branch: "main",
    }),
  },
});

.nojekyll と HTML リダイレクトを出力します。GitHub Pages はカスタムレスポンスヘッダーをサポートしないため、headers は警告になります。条件付きリダイレクトも無条件 HTML リダイレクトへ変換されます。

Netlify

pnpm add -D @natsuneko-laboratory/makit-adapter-netlify

import netlify from "@natsuneko-laboratory/makit-adapter-netlify";

export default defineConfig({
  title: "My Documentation",
  deployment: {
    configFile: { mode: "merge" },
    adapter: netlify({
      generateConfig: true,
      configPath: "netlify.toml",
      redirects: { format: "toml" },
      headers: { format: "toml" },
      i18nRouting: "native",
    }),
  },
});

configFile.mode: "merge" の場合、Adapter は既存の netlify.toml に # makit:start / # makit:end の管理ブロックを作り、既存の独自設定を保持します。

Vercel

pnpm add -D @natsuneko-laboratory/makit-adapter-vercel

import vercel from "@natsuneko-laboratory/makit-adapter-vercel";

export default defineConfig({
  title: "My Documentation",
  build: { trailingSlash: true },
  deployment: {
    cleanUrls: true,
    adapter: vercel({
      generateConfig: true,
      configPath: "vercel.json",
      cleanUrls: true,
      trailingSlash: true,
    }),
  },
});

リダイレクトとヘッダーは vercel.json に変換されます。301 は Vercel の恒久リダイレクト（308）、302 は一時リダイレクト（307）の意味で表されます。国コード条件は Vercel 設定で表現できないため警告されます。

Adapter を選ぶ目安