/gesso-wp

Gesso WordPress theme

Primary LanguageCSS

Gesso for WordPress (w/ Timber)

Gesso is a Sass-based starter theme that outputs accessible HTML5 markup. It uses a mobile-first responsive approach and leverages SMACSS for style organization. This encourages a component-based approach to theming through the creation of discrete, reusable UI elements. Gesso is heavily integrated with Pattern Lab, allowing WordPress and Pattern Lab to share the same markup.

For more information, view the Gesso WordPress GitHub repo. To submit bug reports or feature requests, visit the Gesso WordPress issue queue.

Global Prerequisites

The following packages need to be installed on your system in order to use Gesso WordPress.

Timber

Timber helps you create fully-customized WordPress themes faster with more sustainable code. With Timber, you write your HTML using the Twig Template Engine separate from your PHP files. This cleans-up your theme code so your PHP file can focus on supplying the data and logic, while your twig file can focus 100% on the display and HTML.

Getting Started

Timber Installation

In order to use this theme you must download and activate the Timber Library plugin from Wordpress.org.

Additional information about installing and configuring the Timber Library can be found in the Timber Documentation

Compiling Pattern Lab and Sass

LibSass is required to compile the Sass into CSS. Gesso includes Grunt tasks to compile the CSS and generate the compiled Pattern Lab files and to watch both for changes. To use these tasks, first run the following NPM command in the theme folder (Windows users may need to include the --no-bin-links flag at the end of the command).

npm install

Once the above command is run, the _starter-kit folder that comes with Gesso will be renamed to pattern-lab/source. This directory contains all of the Pattern Lab Twig templates and Sass files.

To initiate the Grunt build tasks that compile the Sass and Pattern Lab files, run the following command in the theme directory:

grunt

Creating New Components

Gesso includes a script to generate new component files. To use, run the following command in the theme folder.

node component

Build Artifacts

By default, the compiled Pattern Lab and Sass files (e.g., /pattern-lab/public/ and /css/) are ignored by Git as these files are built during deployment. To change this, edit the included .gitignore file.

Sass/Grunt dependencies

  • Breakpoint: Easy to write media queries.

  • Sass: CSS on steroids. Adds nested rules, variables, mixins, selector inheritance, and more.

  • Sass Globbing: Adds glob-based imports to Sass.

  • Autoprefixer: Adds necessary browser CSS property prefixes during Sass compilation.

Maintainers

The Gesso theme for WordPress is maintained by Corey Lafferty, Lindsey DiNapoli, Karen Kitchens and Elvis Morales.

Please use the Github issue queue: https://github.com/forumone/gesso-wp/issues