https://github.com/timber/starter-theme

The "_s" for Timber: a dead-simple theme that you can build anything from
https://github.com/timber/starter-theme

php timber twig wordpress-theme

Last synced: 5 days ago
JSON representation

The "_s" for Timber: a dead-simple theme that you can build anything from

• Host: GitHub
• URL: https://github.com/timber/starter-theme
• Owner: timber
• License: mit
• Created: 2015-02-25T23:51:14.000Z (almost 10 years ago)
• Default Branch: 2.x
• Last Pushed: 2024-12-26T16:17:13.000Z (about 1 month ago)
• Last Synced: 2025-01-24T07:01:36.336Z (12 days ago)
• Topics: php, timber, twig, wordpress-theme
• Language: Twig
• Homepage:
• Size: 210 KB
• Stars: 824
• Watchers: 45
• Forks: 278
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# The Timber Starter Theme

[![Build Status](https://travis-ci.com/timber/starter-theme.svg?branch=master)](https://travis-ci.com/github/timber/starter-theme)

[![Packagist Version](https://img.shields.io/packagist/v/timber/starter-theme?include_prereleases)](https://packagist.org/packages/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 files, scripts, and task runners however you would like!

## Installing the theme

Follow the guide on [how to Install Timber using the Starter Theme](https://timber.github.io/docs/v2/installation/installation/#use-the-starter-theme).

Then,

1. Rename the theme folder to something that makes sense for your website. You could keep the name `timber-starter-theme` but the point of a starter theme is to make it your own!

2. Activate the theme in the WordPress Dashboard under **Appearance → Themes**.

3. Do your thing! And read [the docs](https://timber.github.io/docs/).

## The `StarterSite` class

In **functions.php**, we call `new StarterSite();`. The `StarterSite` class sits in the **src** folder. You can update this class to add functionality to your theme. This approach is just one example for how you could do it.

The **src** folder would be the right place to put your classes that [extend Timber’s functionality](https://timber.github.io/docs/v2/guides/extending-timber/).

Small tip: You can make use of Composer’s [autoloading functionality](https://getcomposer.org/doc/04-schema.md#psr-4) to automatically load your PHP classes when they are requested instead of requiring one by one in **functions.php**.

## What else is there?

- `assets/` is where you can keep your front-end scripts, styles, or images. In other words, your Sass files, JS files, fonts, and SVGs would live here.

- `views/` 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.

- `tests/` ... basically don’t worry about (or remove) this unless you know what it is and want to.

## Other Resources

* [Twig for Timber Cheatsheet](https://notlaura.com/the-twig-for-timber-cheatsheet/)

* [Timber and Twig Reignited My Love for WordPress](https://css-tricks.com/timber-and-twig-reignited-my-love-for-wordpress/) on CSS-Tricks

* [A real live Timber theme](https://github.com/laras126/yuling-theme).