Skip to content

Commit

Permalink
Merge pull request #21 from seothemes/d2
Browse files Browse the repository at this point in the history
Integrates D2 Core components
  • Loading branch information
seothemes committed Aug 7, 2018
2 parents b9f72c2 + f4da4db commit 0088692
Show file tree
Hide file tree
Showing 13 changed files with 1,069 additions and 966 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Expand Up @@ -13,3 +13,6 @@ composer.lock

# Ignore editor files.
.idea

# Ignore temporary files.
temp
4 changes: 4 additions & 0 deletions CHANGELOG.md
@@ -1,5 +1,9 @@
# Genesis Starter Theme Changelog

## [3.2.0] - 2018-08-07
* Add d2/core Composer package dependencies
* Update config to use d2 instead of child theme library

## [3.1.0] - 2018-07-12
* Add contributing guidelines
* Add gulp-src-ordered-globs as dependency
Expand Down
2 changes: 1 addition & 1 deletion Gulpfile.js
Expand Up @@ -47,7 +47,7 @@ toolkit.extendConfig(
'./vendor/autoload.php',
'./vendor/composer/*.php',
'./vendor/composer/installed.json',
'./vendor/seothemes/child-theme-library/src/*.php',
'./vendor/d2/**/src/*.php',
'./vendor/tgmpa/tgm-plugin-activation/languages/*',
'./vendor/tgmpa/tgm-plugin-activation/class-tgm-plugin-activation.php'
]
Expand Down
858 changes: 615 additions & 243 deletions LICENSE.md

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions README.md
@@ -1,10 +1,10 @@
# Genesis Starter Theme

[![WordPress](https://img.shields.io/badge/wordpress-4.9.7%20tested-brightgreen.svg)]() [![License](https://img.shields.io/badge/license-GPL--2.0--or--later-blue.svg)](https://github.com/seothemes/child-theme-library/blob/master/LICENSE.md)
[![WordPress](https://img.shields.io/badge/wordpress-4.9.7%20tested-brightgreen.svg)]() [![License](https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg)](https://github.com/seothemes/child-theme-library/blob/master/LICENSE.md)

This is a developer-friendly starter theme used for creating commercial child themes for the Genesis Framework. [Live demo](https://demo.seothemes.com/genesis-starter)
This is a developer-friendly starter theme used for creating commercial child themes for the Genesis Framework. Check out the [live demo](https://demo.seothemes.com/genesis-starter).

It uses the [Child Theme Library](https://github.com/seothemes/child-theme-library) to control all of the theme's logic which can be customized from the child theme's config file, and it uses [Gulp WP Toolkit](https://github.com/craigsimps/gulp-wp-toolkit) to automate mundane build tasks like compiling SCSS and minifying images. Design and styles are based on the latest version of the [Genesis Sample Theme](https://demo.studiopress.com/genesis-sample).
It uses Composer to pull in the [D2 Core](https://github.com/d2themes/core) component library which provides the logic for the theme's configuration, and it uses [Gulp WP Toolkit](https://github.com/craigsimps/gulp-wp-toolkit) to automate mundane build tasks like compiling SCSS and minifying images. Design and styles are based on the latest version of the [Genesis Sample Theme](https://demo.studiopress.com/genesis-sample).

## Table of Contents

Expand Down Expand Up @@ -32,8 +32,8 @@ The Genesis Starter Theme aims to modernize, organize and enhance some aspects o
- [CLI setup script](#setup) to automatically update information
- [Yarn](https://yarnpkg.com/lang/en/docs/install/#mac-stable) or [NPM](https://www.npmjs.com/) for managing Node dependencies
- [Composer](https://getcomposer.org/) for managing PHP dependencies
- [PSR-4](https://www.php-fig.org/psr/psr-4/) autoloading or a basic file autoloader
- [Namespaced](http://php.net/manual/en/language.namespaces.basics.php) (excluding functions.php)
- [PSR-4](https://www.php-fig.org/psr/psr-4/) autoloading
- [Namespaced](http://php.net/manual/en/language.namespaces.basics.php) to avoid naming conflicts

## Requirements

Expand Down Expand Up @@ -85,7 +85,7 @@ The Genesis Starter Theme includes a powerful setup script which automates the p

<a href="https://github.com/seothemes/genesis-starter-theme/blob/master/setup.sh" target="_blank"><img src="https://seothemes.com/wp-content/uploads/2018/07/genesis-starter-theme-setup-script.png" alt="Genesis Starter Theme setup script" width="500"></a>

It replaces the following information with your own:
It replaces the following details with your own:

- Theme name
- Theme textdomain
Expand All @@ -97,11 +97,11 @@ It replaces the following information with your own:

## Usage

The Genesis Starter Theme is intended to be used with the [Child Theme Library](https://github.com/seothemes/child-theme-library). All changes to the child theme should be made via the theme configuration file. This can be used to change almost every aspect of the theme, including theme features, navigation menus, image sizes, widget areas and more. An example config file is available [here](https://github.com/seothemes/child-theme-library/blob/master/docs/example-config.php).
The Genesis Starter Theme is intended to be used with [D2 Core Components](https://packagist.org/packages/d2/). All changes to the child theme should be made via the theme configuration file. This can be used to change almost every aspect of the theme, including theme features, navigation menus, image sizes, widget areas and more. An example config file is included with this theme.

Project details such as theme name, author, version number etc should only ever be changed from the `package.json` file. Gulp reads this file and automatically places the relevant information to the correct locations throughout the theme.
The `app` directory is provided to house project-specific PHP files if additional functionality is required. It comes pre-configured with PSR-4 autoloading. Refer to the [App readme](https://github.com/seothemes/child-theme-library/blob/master/docs/example-config.php) for more information.

The `app` directory is provided to house PHP files if additional functionality is required. It comes pre-configured with PSR-4 autoloading. Refer to the [App readme](https://github.com/seothemes/child-theme-library/blob/master/docs/example-config.php) for more information.
Project details such as theme name, author, version number etc should only ever be changed from the `package.json` file. The Gulp build task reads this file and automatically places the relevant information to the correct locations throughout the theme.

Static assets are organized in the `resources` directory. This folder contains theme scripts, styles, images, fonts, views and language translation files.

Expand Down Expand Up @@ -145,17 +145,17 @@ Contributions are welcome from everyone. We have [contributing guidelines](https

## Authors

<a href="https://seothemes.com" target="_blank"><img src="https://seothemes.com/wp-content/uploads/2018/07/seothemes-genesis-starter-theme.png" alt="SEO Themes logo" width="200"></a>
<a href="https://seothemes.com" target="_blank"><img src="https://seothemes.com/wp-content/uploads/2018/07/seothemes-genesis-starter-theme.png" alt="SEO Themes logo" width="200"></a> &nbsp; <a href="https://github.com/d2themes" target="_blank" rel="nofollow"><img src="https://seothemes.com/wp-content/uploads/2018/08/d2themes.png" alt="D2 Themes logo" width="200"></a>

See also the list of [contributors](https://github.com/seothemes/genesis-starter-theme/graphs/contributors) who participated in this project.

## Special Thanks

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

<a href="https://github.com/craigsimps/" target="_blank">Craig Simpson</a>,
<a href="https://github.com/christophherr/" target="_blank">Christoph Herr</a>,
<a href="https://github.com/garyjones/" target="_blank">Gary Jones</a>,
<a href="https://github.com/craigsimps/" target="_blank">Craig Simpson</a>,
<a href="https://github.com/timothyjensen/" target="_blank">Tim Jensen</a>,
<a href="https://github.com/billerickson/" target="_blank">Bill Erickson</a>,
<a href="https://github.com/srikat/" target="_blank">Sridhar Katakam</a>,
Expand Down
4 changes: 2 additions & 2 deletions app/README.md
@@ -1,6 +1,6 @@
# App Directory

This directory holds all of the source code for your theme. It is pre-configured to use PSR-4 Autoloading for classes with the SEOThemes\GenesisStarterTheme namespace. Files and folders in this directory should be named using the PSR-4 naming convention, e.g `ClassName.php` or `ModuleName/ClassName.php`.
This directory holds all of the app-specific source code for your theme. It is pre-configured to use PSR-4 Autoloading for classes with the SEOThemes\GenesisStarterTheme namespace. Files and folders in this directory should be named using the PSR-4 naming convention, e.g `ClassName.php` or `ModuleName/ClassName.php`.

Below is an example class:

Expand Down Expand Up @@ -71,5 +71,5 @@ new SEOThemes\GenesisStarterTheme\ClassName();
new SEOThemes\GenesisStarterTheme\ModuleName\ClassName();
```

If namespaces and classes are not your thing, there is also a simple file autoloader provided by the Child Theme Library. To use the file autoloader, add your file names to the `autoload` config in the theme configuration file. Using the file autoloader doesn't require the use of PSR-4 naming convention, so you are free to use a typical WordPress file name such as `custom-functions.php`. This file can then be automatically loaded by adding `app/custom-functions` to the autoload config array.
If namespaces and classes are not your thing, you can create standard files e.g: `custom-functions.php`. This file can then be loaded the usual way using an `include_once` statement.

37 changes: 15 additions & 22 deletions composer.json
Expand Up @@ -7,7 +7,7 @@
"wordpress-theme-development",
"genesis-framework"
],
"license": "GPL-2.0-or-later",
"license": "GPL-3.0-or-later",
"authors": [
{
"name": "Lee Anthony",
Expand All @@ -19,28 +19,21 @@
"issues": "https://github.com/seothemes/genesis-starter-theme/issues",
"source": "https://github.com/seothemes/genesis-starter-theme"
},
"repositories": [
{
"type": "package",
"package": {
"name": "tgmpa/tgm-plugin-activation",
"version": "2.6.1",
"type": "package",
"dist": {
"url": "https://github.com/TGMPA/TGM-Plugin-Activation/archive/2.6.1.zip",
"type": "zip"
},
"autoload": {
"files": []
}
},
"url": "https://github.com/TGMPA/TGM-Plugin-Activation.git"
}
],
"require": {
"php": "^5.4|^7",
"seothemes/child-theme-library": "dev-master",
"tgmpa/tgm-plugin-activation": "*"
"php": ">=5.6",
"d2/core-asset-loader": "^0.2.0",
"d2/core-constants": "^0.1.0",
"d2/core-custom-colors": "^0.1.0",
"d2/core-genesis-layouts": "^0.1.0",
"d2/core-genesis-settings": "^0.1.0",
"d2/core-google-fonts": "^0.1.0",
"d2/core-hooks": "^0.2.0",
"d2/core-image-sizes": "^0.1.0",
"d2/core-plugin-activation": "^0.1.0",
"d2/core-simple-social-icons": "^0.1.0",
"d2/core-textdomain": "^0.1.0",
"d2/core-theme-support": "^0.1.0",
"d2/core-widget-areas": "^0.1.0"
},
"require-dev": {},
"autoload": {
Expand Down

0 comments on commit 0088692

Please sign in to comment.