jekyll-theme-easy-wedding is a Jekyll theme that turns YAML data files into a complete wedding website, so couples can launch a polished site without hand-writing HTML.
What is jekyll-theme-easy-wedding?
jekyll-theme-easy-wedding is an open-source Jekyll theme, distributed as a Ruby gem, for quickly building customizable wedding websites. It takes YAML data files as input and produces a static wedding site as output. The theme was created by cnorick, who first built a site for his own wedding and then reused the design for friends by templating the content into YAML. It is based on original work by @cbaclig from the repository https://github.com/cbaclig/wedding.
Key Features
- YAML-driven configuration — Everything from event details to guest information is stored in YAML files under the
_datafolder, so editing content requires no HTML knowledge. - Ready-to-copy example folder — The repository includes an
exampledirectory that you can copy into your project and modify, providing a complete reference site. - Jekyll theme gem — Install it by adding
gem "jekyll-theme-easy-wedding"to your Gemfile and settingtheme: jekyll-theme-easy-weddingin_config.yml, then runbundle. - Standard Jekyll structure — The theme uses
_layouts,_includes,_sass, andassetsdirectories, so it behaves like any normal Jekyll site and works with Jekyll's build and serve workflow. - Built-in development workflow — Run
bundle exec jekyll serveto test the theme locally athttp://localhost:4000; changes to theme files regenerate the site automatically. - MIT licensed — The theme is open source under the MIT License, allowing free use, modification, and redistribution.
- RSVP-ready — The repository is tagged with
wedding-rsvp, indicating the theme anticipates handling guest RSVPs as part of a wedding site.
Who is it for?
- Engaged couples — Publish a wedding website quickly by editing YAML data instead of building pages from scratch, covering the core information guests need.
- Jekyll developers — Use the theme as a starting point for client work or personal projects, and contribute improvements through bug reports and pull requests on GitHub.
- Friends and family of the author — The theme was born from a need to reuse the same wedding site design across multiple weddings, so it fits anyone who wants a consistent, configurable template.
What can you do with jekyll-theme-easy-wedding?
- Engaged couples: Set up a wedding website with event information, location details, and guest-facing content by editing YAML files in the
_datadirectory, then deploying the generated static site. - Jekyll users: Explore the example folder to see how the theme is structured, then adapt the YAML data model to match your own wedding details.
- Contributors: Report bugs or submit pull requests to improve the theme, guided by the Contributor Covenant code of conduct mentioned in the README.
How does jekyll-theme-easy-wedding work?
To use the theme, copy the example folder into your Jekyll project, then edit the YAML files inside _data to replace placeholder details with your wedding information. After that, run bundle install and bundle exec jekyll serve to preview the site locally, then build and deploy as a normal Jekyll site.
Pricing
The theme is free and open source under the MIT License. There are no paid tiers or licensing fees.
FAQ
Is jekyll-theme-easy-wedding free?
Yes, the theme is released under the MIT License, so you can use it for personal or commercial wedding websites without cost, and you may modify and redistribute it under the license terms.
How do I install the theme?
Add gem "jekyll-theme-easy-wedding" to your Gemfile, set theme: jekyll-theme-easy-wedding in _config.yml, then run bundle to install the gem. The README also shows how to install it directly with gem install jekyll-theme-easy-wedding.
How do I customize the website content?
The quickest way is to copy the example folder into your project and edit the YAML files in the _data directory. These files hold the data that the theme's templates use to render the site, so you can change text, dates, and other details without touching HTML.
Does the theme include RSVP functionality?
The repository is tagged with wedding-rsvp, and the theme's origin as a wedding site suggests it supports RSVP-related pages. For exact RSVP features, check the example folder and page templates in the theme source.
What license is the theme distributed under?
It is distributed under the MIT License, and the README links to opensource.org/licenses/MIT for the full license text.
