yeuchaybo/lib/README.md

Child Theme Library

A configuration based drop-in library for extending Genesis child themes. See an example of how to integrate the library here or check out the live demo.

Why was the Child Theme Library built?

The main purpose of the Child Theme Library is to provide a shareable codebase for commercial Genesis child themes. This is achieved by using configuration-based architecture to separate the theme's reusable logic from it's configuration. Using this approach, we are able to use a single codebase which can be heavily customized by passing in different configs.

Installation

Composer (recommended)

Include the package and the custom directory installer package in your child theme's composer.json file

"require":{
  "mnsami/composer-custom-directory-installer": "1.1.*",
  "seothemes/child-theme-library": "dev-master"
}

In the extra section define the custom directory you want the package to be installed in:

"extra":{
  "installer-paths":{
    "./lib/": ["seothemes/child-theme-library"]
  }
},

While the child theme library is in beta, you will also need to add the repository details:

"repositories": [
  {
    "type": "git",
    "url": "https://github.com/seothemes/child-theme-library.git"
  }
],

An example composer.json file can be found here

Git

The Child Theme Library can be installed as a Git Submodule. This allows the library to receive future updates with ease. If you are not familiar with Git Submodules please read this article.

From the terminal, navigate to your project directory:

cd wp-content/themes/my-theme

Clone from Github into the lib directory. This creates a submodule:

git submodule add https://github.com/seothemes/child-theme-library.git lib

Include the library from your functions.php file by placing the following line after the Genesis Framework has loaded:

// Load Child Theme Library (do not remove).
require_once get_stylesheet_directory() . '/lib/init.php';

Manually

Download the zip file from Github here.

Upload the file to your theme's main directory and unzip the contents.

Include the library from your functions.php file, before any custom code is loaded e.g:

// Load child theme's lib (do not remove).
require_once get_stylesheet_directory() . '/lib/init.php';

Setup

Once the library has been included in your theme, it is ready to accept your config file. By default, this should be placed in ./config/config.php, however this location can be changed by using the config path filter, e.g:

add_filter( 'child_theme_config', get_stylesheet_directory() . 'my-config.php' );

A working example of the config file with all of the possible settings can be found here.

Structure

The Child Theme Library loosely resembles the current Genesis Framework file structure:

lib/
├── admin/
│   ├── customizer-output.php
│   └── customizer-settings.php
├── classes/
│   ├── class-rgba-customizer-control.php
│   └── class-tgm-plugin-activation.php
├── css/
│   ├── customizer.css
│   ├── library.css
│   └── load-styles.php
├── functions/
│   ├── attributes.php
│   ├── defaults.php
│   ├── demo.php
│   ├── general.php
│   ├── hero.php
│   ├── layout.php
│   ├── markup.php
│   ├── plugins.php
│   ├── setup.php
│   ├── templates.php
│   ├── upgrade.php
│   └── utilities.php
├── js/
│   ├── customizer.js
│   ├── library.js
│   ├── menu.js
│   └── load-scripts.php
├── languages/
│   └── child-theme-library.pot
├── shortcodes/
│   └── footer.php
├── structure/
│   ├── footer.php
│   ├── header.php
│   └── menu.php
├── views/
│   ├── page-front.php
│   ├── page-full.php
│   ├── page-landing.php
│   └── page-sitemap.php
├── widgets/
│   └── widgets.php
├── .gitattributes
├── composer.json
├── README.md
├── autoload.php
└── init.php

Support

Please visit https://github.com/seothemes/child-theme-library/issues/ to open a new issue.

Authors

• Lee Anthony - SEO Themes

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU General Public License - see the LICENSE.md file for details.

Acknowledgments

A shout out to anyone who's code was used in or provided inspiration to this project:

• Gary Jones
• Craig Simpson
• Tim Jensen
• Craig Watson
• Sridhar Katakam
• Christoph Herr
• Bill Erickson
• Chinmoy Paul
• Nathan Rice
• Calvin Koepke
• Jen Baumann
• Brian Gardner
• Robin Cornett