jekyll-theme-modootoday

A Jekyll theme that keeps page bodies in plain GitHub Markdown and styles them with layouts, includes and CSS.

Documentation · 한국어

• Only standard Markdown in your pages. GFM plus GitHub alerts; the same file reads well on github.com.
• Works on GitHub Pages. Layouts and includes are Liquid only, so remote_theme works on the classic build; Jekyll 4 works too.
• Components without markup. Alerts, status badges, card grids, tabs, buttons, accordion, steps, timeline and more come from plain Markdown patterns.
• Readable by agents. Every page can have a byte-identical Markdown twin, plus llms.txt and llms-full.txt.
• Accessible. Keyboard shortcuts, visible focus, safe areas on phones, 44 px touch targets, high contrast and reduced motion are built in.
• Checked. modootoday-check validates the sources and the built site.

As a gem (theme:):

# Gemfile
gem "jekyll-theme-modootoday", "~> 1.2"

# _config.yml
theme: jekyll-theme-modootoday

On GitHub Pages without a Gemfile (remote_theme:):

# _config.yml
remote_theme: modootoday/jekyll-theme-modootoday@v1.2.0
plugins:
  - jekyll-remote-theme

Pin a tag or a commit. More options: Install guide.

mkdir my-docs && cd my-docs
printf 'source "https://rubygems.org"\ngem "jekyll", "~> 4.4"\ngem "jekyll-theme-modootoday", "~> 1.2"\n' > Gemfile
printf 'theme: jekyll-theme-modootoday\nmarkdown: kramdown\nkramdown: {input: GFM}\nsass: {style: compressed, silence_deprecations: [import, global-builtin]}\n' > _config.yml
printf -- '---\nlayout: doc\ntitle: Home\n---\n# Hello\n\n> [!TIP]\n> Plain Markdown, styled.\n' > index.md
bundle install && bundle exec jekyll build
bundle exec modootoday-check . _site

Walkthrough: Write your first page.

• Plain body, rich layout. The body is GFM; sections: front matter maps each ## to a component. See Components and the kitchen sink.
• Rules. What may appear in a body, and what each pattern becomes, is defined in RULES.md (md-components v1).
• Settings and tokens. One modootoday: block in _config.yml, CSS custom properties --mt-*, one Sass partial per component. See Configuration and Customize.
• Blog and news. blog, news, news-article, author and feed layouts: paginated card lists (list, grid, magazine), bylines from _data/authors.yml, series, related posts, share, JSON-LD, per-language Atom feeds; Liquid only, styles and script in an optional bundle. See Blog and news.
• Twins: three ways — stub files (default, classic Pages), the jekyll-theme-modootoday plugin (Jekyll 4 / Actions), or modootoday.twins: source with front-matter-less pages (classic Pages, no stubs). See RULES.md §5a.

modootoday-check SRC SITE [options] (run after jekyll build):

• Each page guide.md has a twin at /guide/index.md with the same bytes as its body, linked with rel="alternate" type="text/markdown".
• llms.txt and llms-full.txt exist at / and under each /<lang>/.
• Jekyll 4: plugins: [jekyll-theme-modootoday] creates them; the classic GitHub Pages build uses one-file stubs.
• Details: Agents guide and this repository's own llms.txt.

• Documentation site (built with this theme from docs/)
• Install · First page · Components · Configuration · Customize · Blog and news · Public API · Migrate and upgrade · CSP · Accessibility · Roadmap · Changelog
• Supported stacks: GitHub Pages (github-pages 232, Jekyll 3.10, Ruby 3.3.4) and Jekyll 4.4 on Ruby 3.2 to 3.4, all tested in CI; Jekyll 3.9 is the tested floor.
• Security policy · Code of conduct

Issues and pull requests are welcome. English is the canonical language; translations follow it. See CONTRIBUTING.md.

MIT © modootoday (모두의오늘)