2017 © Pedro Peláez
 

wordpress-theme wordpress-starter-theme

Starter theme to build a Timber theme

image

circul8/wordpress-starter-theme

Starter theme to build a Timber theme

  • Friday, June 15, 2018
  • by lucien144
  • Repository
  • 1 Watchers
  • 0 Stars
  • 64 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 130 Forks
  • 1 Open issues
  • 3 Versions
  • 100 % Grown

The README.md

Wordpress Starter Theme

Packagist, (*1)

Starter theme based on Timber's Starter Theme. It is already part of Circul8 Wordpress Stack, can be also used with Root's Bedrock or normal Wordpress installation., (*2)

Installation

  1. Using Circul8 Wordpress Stack
    1. composer create-project circul8/wordpress new-project
  2. Using Bedrock or normal Wordpress installation
    1. Navigate to /web/app/themes/ or /wp-content/themes/
    2. Run git clone git@github.com:circul8/wordpress-starter-theme.git
    3. Run composer install

Dependencies

Templating system

Templating is done by Timber plugin which uses Twig., (*3)

Custom filters

Filter Description
dump Dumps the variable to the Tracy's debug panel.
cfs($post_id = NULL, $options = []) Returns CFS()->get($field_name, $post_id, $options) as descibred here where $field_name is filtered value.
post Returns new Timber\Post($id) where $id is filtered value.
image Returns new Timber\Image($id) where $id is filtered value.
target Returns _blank or _self, expects Hyperlink Array from CFS.
webalize Webalize string: "Hello, my friend!" -> "hello-my-friend"

Plugins

Those 👇 are Must-Use plugins installed into mu-plugins folder. If you install this theme from project's root using composer require, those plugins may be installed into plugins folder instead., (*4)

Plugin Description
timber-library The core plugin to create custom theme.
custom-field-suite To manage custom fields.
wp-tracy Debugging, adds debug panel.
disable-comments To disable comments.
tinymce-advanced Advanced WYSIWYG.

Directory structure

├─ assets           ← Static files - images, CSS, LESS, gulp, JS, ...
├─ defaults         ← Timber's starter theme twig files for fallback.
├─ pages            ← Custom Wordpress template pages (.php)
├─ templates            ← Custom twig templates.
│   └─ partials         ← Components & other partials such as HTML header, footer, GA, ...
├─ admin.CSS            ← Custom CSS sheet for administration.
└─ functions.php        ← Theme boostrap

The Versions

15/06 2018

dev-master

9999999-dev

Starter theme to build a Timber theme

  Sources   Download

MIT

The Requires

  • wpackagist-plugin/wp-tracy ^1.0
  • wpackagist-plugin/tinymce-advanced ^4.5
  • wpackagist-plugin/disable-comments ^1.7
  • advanced-custom-fields/advanced-custom-fields-pro *
  • wpackagist-plugin/types ^2.3.1
  • wpackagist-plugin/post-types-order ^1.9.3
  • wpackagist-plugin/timber-library ^1.2

 

by Avatar jarednova
by Jan Blasko

22/02 2016

dev-composer_updates

dev-composer_updates

Starter theme to build a Timber theme

  Sources   Download

The Requires

  • wpackagist-plugin/timber-library 0.22.*

 

by Avatar jarednova

11/08 2015

dev-travis_tests

dev-travis_tests

Starter theme to build a Timber theme

  Sources   Download

The Requires

  • wpackagist-plugin/timber-library 0.21.*

 

by Avatar jarednova