Configuration

Keys

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 validates every key. The full list of stable names is in Public API.

Links that open a new window

Opening a new window is opt-in. Set it per link or for every external link.

# _config.yml: every external link
modootoday:
  external_links:
    new_window: true
    icon: true        # false hides the arrow

# per link: nav items, cards, buttons, link cards, directory items, pricing cta, footer links
- {title: "Status page", url: "https://status.example.com", new_window: true}
- {title: "Forum", url: "https://forum.example.com", target: _blank}

[Release notes](https://github.com/modootoday/jekyll-theme-modootoday/releases "new-window")

Each such link gets target="_blank", rel="noopener noreferrer", a small arrow drawn in CSS, and a hidden hint (“opens in a new window”, translated into the page language) that screen readers read through aria-describedby. There is no script, so a strict Content Security Policy keeps working. new_window: false on a link turns it off even when the site setting is on.

Head and SEO

With url: set, every page gets a canonical link and Open Graph tags; no plugin is needed. With languages: set, pages that exist in several languages link each other with hreflang. Sitemaps and feeds are opt-in plugins that GitHub Pages allows:

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]

To use jekyll-seo-tag instead, set seo: false and put the jekyll-seo-tag seo tag in _includes/head-custom.html. A page can show its date with last_modified_at: in front matter. The first breadcrumb shows the home page short_title: (front matter) when set, otherwise its title. Strict Content Security Policy: see CSP.

Languages

Put interface strings in _data/i18n/<lang>.yml and pages in <lang>/:

language: 한국어
site_title: 모두의오늘 테마   # header, <title>, og:site_name and JSON-LD name; falls back to site.title
callout: {note: 참고, tip: 팁, important: 중요, warning: 경고, caution: 주의}
tabs: {label: 설치 방법}
status: {available: 사용 가능, partial: 일부 구현, planned: 계획}
skip: 본문으로 건너뛰기

Set lang: and the theme’s own labels (skip link, navigation, callouts, status badges, table of contents, pagination, code copy, search, language menu) are already localized for 23 languages: 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. Nothing needs to be copied, on GitHub Pages or with Jekyll 4. A code with a region the theme does not ship uses its base language (pt → pt-BR, zh → zh-CN); any other language shows English.

Each label is resolved in this order:

1. your _data/i18n/<lang>.yml, key by key
2. the theme’s catalog for that language
3. English

So a site catalog only needs the keys you want to change, plus anything your own components read. Use the .yml extension; the checker rejects .yaml. To start from the theme’s wording, copy a catalog and check it:

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

For a language the theme does not ship, add _data/i18n/<code>.yml with the keys of the English catalog and list the code in languages. Pages get dir="rtl" for Arabic, Persian, Hebrew, Urdu and other right-to-left languages (ur-Latn stays left-to-right); direction: rtl or ltr in a catalog or in front matter overrides it. Page content is translated as Markdown in <lang>/, not in the catalogs.

Pages that translate each other under different paths share a ref: in front matter, such as ref: guide on guides/start.md and ko/guides/sijak.md. hreflang links and the language switcher then use that page; a page with ref: and no translation is left out of hreflang, and the switcher sends that language to its home page. In includes and layouts, modootoday/link.html with ref="guide" gives the URL of the ref: guide page in the current language, or in the default language when there is none (add exact=true for no fallback, absolute=true for a full URL); modootoday-check reports a ref= that no page defines. With full_languages set, modootoday-check . _site --i18n-pages lists default-language pages that have no translation in those languages (same ref:, or the same path under <lang>/); they are warnings, and --strict makes them fail.

Some labels are your site’s, not the theme’s: tabs.label names the tab list on pages that use tabs (for example tabs: {label: Install method}), so screen readers announce what the tabs choose between. Put it in each language’s catalog.

In your own includes, modootoday/t.html with key="nav.label" prints a label with the same resolution.

Component registry

An optional _data/components.yml lets the checker validate sections: parameters:

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