移行とアップグレード

注記

このページは英語の原文の翻訳です。内容が異なる場合は英語版が優先されます。

別のテーマから

1. theme: または remote_theme: をこのテーマに置き換え (インストールを参照)、バージョンを固定します。
2. _config.yml で layout: doc を既定にするか、独自のレイアウトを残して必要な部分だけを include します。
3. ページ本文はそのままにします。GitHub アラート、表、フェンスコードはすでに動きます。できるところでは本文から生の HTML と Liquid を取り除きます。移植できないものは modootoday-check が一覧にします。
4. 色とフォントは CSS セレクターを上書きせず modootoday.tokens に移します。
5. jekyll build と modootoday-check SRC _site を実行し、報告された内容を直します。

よくある対応: minima の layout: page と just-the-docs の layout: default は layout: doc になります。include note.html タグで作ったコールアウトは > [!NOTE] に、HTML で書いたバッジは `status:available` のコードスパンになります。

既存プロジェクトへの導入

方法	使う場面	更新
Gem (theme:)	サイトに Gemfile がある (Jekyll 4 または github-pages gem)	bundle update jekyll-theme-modootoday
remote_theme:	Gemfile のないクラシックな GitHub Pages	@vX.Y.Z タグを変える
コピーして取り込む	レイアウトをフォークする必要がある、または依存を追加できない	タグ付きリリースから _layouts、_includes、_sass、assets をコピーしてバージョンを記録する。更新は手作業でマージする

gem か、タグに固定した remote_theme: を推奨します。コピーで取り込むと、変更したファイルについてはアップグレードとチェッカーの保証を失います。

Markdown 版

各ページのエージェント向け Markdown 版を公開する方法を三つから選びます。

• スタブファイル (既定、クラシックな GitHub Pages): ページごとに小さな <page>.md.txt を一つ。
• プラグイン (Jekyll 4 または GitHub Actions): plugins: [jekyll-theme-modootoday] がスタブなしで Markdown 版と llms.txt を作ります。
• ソースモード (クラシックな GitHub Pages、スタブなし): front matter のないページで modootoday.twins: source を使います。クラシックな GitHub Pages は生のコピーをソースと同一のまま text/markdown; charset=utf-8 として配信します (制限は RULES.md §5a を参照)。

切り替えてもページ本文は変わりません。エージェントと RULES.md の 5a 節を参照してください。

jekyll-seo-tag から移る

jekyll-seo-tag の代わりにキットに SEO タグを書かせるには、次のようにします。

1. plugins: と Gemfile から jekyll-seo-tag を削除し、_includes/head-custom.html から seo タグを削除します。
2. modootoday: から seo: false と hreflang: true を削除します。キットが canonical リンク、hreflang の alternate リンク、Open Graph を再び書きます。手で追加した alternate リンクは削除し、同じリンクが二重に出ないようにします。
3. ブラウザーのバーの色は modootoday.theme_color で指定します（設定を参照）。キットは既定でライト用とダーク用の theme-color タグを 2 つ書きます。独自の theme-color タグがあれば削除します。残すと 1 ページに 3 つになります。
4. キットが書くのは twitter:card だけです（ページに画像があれば summary_large_image）。twitter: の設定は読まないため、twitter:site が必要なら _includes/head-custom.html に meta タグで追加します。
5. 再ビルドして modootoday-check SRC _site を実行します。jekyll-seo-tag の JSON-LD に関する警告が消えているはずです。

アップグレード

飛ばすすべてのバージョンについて CHANGELOG.md を読んでください。文書化された名前は公開 APIにあります。アップグレード後に modootoday-check --strict を実行してください。

移行元	移行先	やること
1.0.0 より前のリポジトリからのビルド	1.0	~> 1.0 または @v1.0.0 に固定し、modootoday-check --strict を実行する
1.0 または 1.1	1.2	~> 1.2（remote_theme では最新の v1.2.x タグ）に固定する。新しいセクションとヒーローのオプション（bleed:、reveal:、visual: と組み合わせる c: split）は任意なので、ページの修正は不要。modootoday-check --strict を実行する
1.2	1.3	~> 1.3（remote_theme では @v1.3.0）に固定する。reference のサイドバー（sidebar: true）とパッケージ表（packages:）は任意なので、ページの修正は不要。modootoday-check --strict を実行する
1.3	1.4	~> 1.4（remote_theme では @v1.4.1）に固定する。packages_compact と packages_position は任意で、reference ページも doc と同じくアラートを変換するようになったため、ページの修正は不要。modootoday-check --strict を実行する

## 見出しより少ない sections: 項目を許していた 1.0 以前の草案を使っていたなら、残りの見出しごとに notes のような名前だけを足してください。今は数が一致する必要があり、modootoday-check がページと両方の数を報告します。