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:
- Make sure you have installed the plugin for the Timber Library (and Advanced Custom Fields - they play quite nicely together).
- Download the zip for this theme (or clone it) and move it to
wp-content/themes
in your WordPress installation. - 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! - Activate the theme in Appearance > Themes.
- Go to your theme folder and install the dependencies.
$ npm install
$ npm run dev
$ npm run watch
For production ...
$ npm run prod
- Do your thing! And read Timber docs and Tailwind docs.
assets/src
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.
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.
bin/
and tests/
... basically don't worry about (or remove) these unless you know what they are and want to.