szepeviktor/starter-theme

Starter theme to build a Timber theme

Maintainers

Details

github.com/szepeviktor/starter-theme

Source

Issues

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 278

Open Issues: 0

Type:wordpress-theme

v2.0 2023-03-14 18:01 UTC

Requires

Requires (Dev)

MIT f91517cb957a9c545f231a8dab19799638dcdac2

  • jarednova <jared.woop@upstatement.com>
  • Viktor Szépe <viktor.woop@szepe.net>

This package is auto-updated.

Last update: 2024-10-09 09:13:59 UTC

README

Build Status Packagist Version

The "_s" for Timber: a 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!

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. 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.

theme/ contains all of the PHP and other files needed by WordPress. When using the Timber Starter Theme as a parent theme, you need to include the theme directory in your child theme’s style.css docblock like so: Template: timber-starter-theme/theme

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) these unless you know what they are and want to.

Remove wp-block-library stylesheet

Remove block-library/style.min.css if your theme does not support the Block Editor aka. Gutenberg.

remove_action('wp_enqueue_scripts', 'wp_common_block_scripts_and_styles');

Other resources