Skip to content

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

License

Notifications You must be signed in to change notification settings

tameroski/timber_s

 
 

Repository files navigation

The Timber Starter Theme

The "_s" for Timber: a dead-simple theme that you can build from, using Bulma and some useful gulp magic.

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:

  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. Unzip it in a folder of your choice
  4. Run npm install
  5. Run npm init --name=THEME_NAME if you want your theme to have a specific name. No spaces or special characters allowed.
  6. Activate the theme in Appearance > Themes.
  7. Edit the proxy variable in gulpfile.js to point to your site URL.
  8. Run gulp to start watching for sass/javascript changes and sync your browser. The browser sync will run at the default localhost:3000 domain (context path is unchanged).
  9. Do your thing! And read the docs

Don't forget to edit humans.txt.

What's here?

src/ is where the source files for your sass and javascript should live.

static/ is where you can keep your static front-end stuff like images, font files, etc.

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.

Other Resources

The main Timber Wiki is super great, so reference those often. Also, check out these articles and projects for more info:

About

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

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 47.0%
  • PHP 35.9%
  • JavaScript 13.8%
  • CSS 3.3%