upstatement/timber-starter-theme

Starter theme to build a Timber theme

The Timber Starter Theme

The "_s" for Timber: a dead-simple theme that you can build from. The primary purpose of this theme is to provide a file structure rather than a framework for markup or styles. Configure your Sass, scripts, and task runners however you would like!, _(*1)

, _(*2)

Installing the Theme

Install this theme as you would any other, and be sure the Timber plugin is activated. But hey, let's break it down into some bullets:, _(*3)

1. Make sure you have installed the plugin for the Timber Library (and Advanced Custom Fields - they play quite nicely together).
2. Download the zip for this theme (or clone it) and move it to wp-content/themes in your WordPress installation.
3. Rename the folder to something that makes sense for your website (generally no spaces and all lowercase). You could keep the name timber-starter-theme but the point of a starter theme is to make it your own!
4. Activate the theme in Appearance > Themes.
5. Do your thing! And read the docs.

What's here?

static/ is where you can keep your static front-end scripts, styles, or images. In other words, your Sass files, JS files, fonts, and SVGs would live here., _(*4)

templates/ contains all of your Twig templates. These pretty much correspond 1 to 1 with the PHP files that respond to the WordPress template hierarchy. At the end of each PHP template, you'll notice a Timber::render() function whose first parameter is the Twig file where that data (or $context) will be used. Just an FYI., _(*5)

bin/ and tests/ ... basically don't worry about (or remove) these unless you know what they are and want to., _(*6)

Other Resources

• This branch of the starter theme has some more example code with ACF and a slightly different set up.
• Twig for Timber Cheatsheet
• Timber and Twig Reignited My Love for WordPress on CSS-Tricks
• A real live Timber theme.
• Timber Video Tutorials and an incomplete set of screencasts for building a Timber theme from scratch.