Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 3.96 KB

README.md

File metadata and controls

83 lines (58 loc) · 3.96 KB
Raw

The Timber Starter Theme with Webpack

This is basically the Timber starter theme but with webpack added for managing front-end assets.

What's included

  • Timber template engine
  • npm for managing front-end dependencies
  • webpack for bundling JavaScript and managing assets
  • Babel for compiling JavaScript
  • Sass for compiling stylesheets
  • Autoprefixer
  • SVG optimization with svgo
  • File name hashes for long term caching

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. 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. Update publicPath in webpack.config.js to point to correct theme folder after changing the theme name
  5. Activate the theme in Appearance > Themes.
  6. Install and build frontend dependencies by navigating to theme folder and running npm install && npx webpack -w
  7. Do your thing! And read the docs.

Building for production

Run cd wp-content/themes/my-theme/ && npm install && npx webpack -p to build minified files for production.

What's here?

src/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

How can I copy assets like images and fonts to the dist folder?

With webpack, you don't need to. Just put your images and fonts under src and use relative path to the resource. webpack will automatically resolve the paths for you and copy the assets to the right place under dist. You can learn more about this by reading this blog post.

Like this with a font in a stylesheet:

@font-face {
  font-family: 'Open Sans';
  font-style: normal;
  font-weight: 400;
  src: url('./fonts/open-sans-v15-latin_latin-ext-regular.woff2')
      format('woff2'),
    url('./fonts/open-sans-v15-latin_latin-ext-regular.woff')
      format('woff');
}

It works even in twig files:

<img src="./images/logo.svg" alt="Logo">

How can I inline SVGs?

You can use interpolation with html-loaderand use webpack loader override syntax to get the file contents instead of a path to the file:

<div class="icon">
${require('!raw-loader!./images/logo.svg')}
</div>

License

GPL v2 or later

This theme is based on the original Timber Starter Theme by Jared Novack and contributors, licensed under the MIT license