設定

キー

modootoday:
  color_scheme: auto  # auto | auto-dark | auto-light | light | dark
  components: [callout, badge, cta, card, tabs]
  tokens: {primary: "#4f46e5", radius: "0.5rem"}
  nav: main

modootoday-check はすべてのキーを検証します。安定した名前の一覧は公開 APIにあります。

新しいウィンドウで開くリンク

新しいウィンドウで開く動作は、明示的に有効にしたときだけ働きます。リンクごと、または外部リンク全体に設定できます。

# _config.yml: 外部リンク全体
modootoday:
  external_links:
    new_window: true
    icon: true        # false で矢印を隠します

# リンクごと: ナビ、カード、ボタン、リンクカード、ディレクトリ項目、料金プランのボタン、フッターのリンク
- {title: "ステータスページ", url: "https://status.example.com", new_window: true}
- {title: "フォーラム", url: "https://forum.example.com", target: _blank}

[リリースノート](https://github.com/modootoday/jekyll-theme-modootoday/releases "new-window")

こうしたリンクには target="_blank"、rel="noopener noreferrer"、CSS で描いた小さな矢印、そしてスクリーンリーダーが aria-describedby で読み上げる非表示の案内（「新しいウィンドウで開きます」、ページの言語に翻訳）が付きます。スクリプトは使わないので、厳しいコンテンツセキュリティポリシー（CSP）でもそのまま動きます。サイト設定を有効にしていても、リンクに new_window: false を書くとそのリンクは同じウィンドウで開きます。

head と SEO

url: を設定すると、すべてのページに canonical リンクと Open Graph タグが付きます。プラグインは要りません。languages: を設定すると、複数の言語にあるページが hreflang で互いにリンクします。サイトマップとフィードは、GitHub Pages が許可するプラグインを使う任意機能です。

url: https://example.github.io
modootoday:
  languages: [en, ko]
  edit_url: https://github.com/OWNER/REPO/edit/main/docs/
plugins: [jekyll-remote-theme, jekyll-sitemap, jekyll-feed]

代わりに jekyll-seo-tag を使うなら、seo: false にして jekyll-seo-tag の seo タグを _includes/head-custom.html に入れます。front matter の last_modified_at: でページに日付を表示できます。パンくずリストの最初の項目は、ホームページの front matter に short_title: があればそれを、なければ title を表示します。厳格な Content Security Policy については CSP を参照してください。

言語

UI の文字列は _data/i18n/<lang>.yml に、ページは <lang>/ に置きます。

language: 한국어
site_title: 모두의오늘 테마 # ヘッダー、<title>、og:site_name、JSON-LD の名前。ない場合は site.title
callout: {note: 참고, tip: 팁, important: 중요, warning: 경고, caution: 주의}
tabs: {label: 설치 방법}
status: {available: 사용 가능, partial: 일부 구현, planned: 계획}
skip: 본문으로 건너뛰기

lang: を指定するだけで、テーマが表示する文言（本文へのスキップリンク、ナビゲーション、アラート、ステータスバッジ、目次、前後のページ、コードのコピー、検索、言語メニュー）が 23 言語でローカライズされます。対応言語は en、zh-CN、zh-TW、ja、ko、tr、ru、vi、th、de、es、fr、uk、pl、pt-BR、ar、fa、id、it、el、ml、ur-Latn、ro です。GitHub Pages でも Jekyll 4 でも、何もコピーする必要はありません。テーマにない地域コードは基本の言語を使い（pt → pt-BR、zh → zh-CN）、それ以外の言語は英語で表示されます。

各文言は次の順に決まります。

1. サイトの _data/i18n/<lang>.yml（キー単位）
2. テーマに含まれるその言語のカタログ
3. 英語

そのため、サイトのカタログには変更したいキーと、独自のコンポーネントが使うキーだけを書けば十分です。拡張子は .yml を使ってください。チェッカーは .yaml をエラーにします。テーマの文言をもとに編集する場合は、カタログをコピーしてからチェックします。

modootoday-check . _site --i18n-init=ko   # optional: copy the theme's ko.yml to edit
modootoday-check . _site --i18n           # unknown keys and placeholder mismatches

テーマにない言語を追加するには、英語のカタログと同じキーで _data/i18n/<code>.yml を作り、languages にコードを加えます。アラビア語、ペルシア語、ヘブライ語、ウルドゥー語などの RTL 言語のページには dir="rtl" が付きます（ur-Latn は左から右）。カタログか front matter の direction: rtl または ltr で上書きできます。ページ本文はカタログではなく、<lang>/ の Markdown で翻訳します。

パスが異なる翻訳ページどうしは、front matter に同じ ref: を書きます。たとえば guides/start.md と ko/guides/sijak.md の両方に ref: guide を書きます。すると hreflang リンクと言語スイッチャーがそのページを使います。ref: があって翻訳がないページは hreflang から外れ、言語スイッチャーはその言語のホームへ案内します。include とレイアウトでは、modootoday/link.html に ref="guide" を渡すと、現在の言語の ref: guide ページの URL を、なければ既定言語のページの URL を返します(代替しない場合は exact=true、完全な URL は absolute=true)。どのページにもない ref= は modootoday-check がエラーにします。full_languages を設定すると、modootoday-check . _site --i18n-pages がその言語の翻訳(同じ ref:、または <lang>/ 以下の同じパス)がない既定言語のページを警告として表示します。--strict と併用すると失敗します。

テーマではなくサイト側で決める文言もあります。tabs.label はタブを使うページでタブ一覧に付ける名前です(例: tabs: {label: インストール方法})。スクリーンリーダーが何を切り替えるタブかを読み上げるので、言語ごとのカタログに入れてください。

独自の include では、modootoday/t.html に key="nav.label" を渡すと、同じ順序で解決された文言を出力できます。

コンポーネントレジストリ

任意の _data/components.yml を置くと、チェッカーが sections: のパラメーターを検証します。

features: {params: {cols: {allowed: [2, 3, 4], required: false}, badge: {allowed: [bottom], required: false}}}
tabs: {i18n: [tabs.label]}
cta: {}