-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 4e7a4b3
Showing
16 changed files
with
2,954 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# This file is for unifying the coding style for different editors and IDEs | ||
# editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
end_of_line = lf | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
indent_style = tab | ||
|
||
[{.*rc,*.json,*.yml}] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[composer.json] | ||
indent_size = 4 | ||
|
||
[*.txt] | ||
end_of_line = crlf | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
vendor/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Change Log for Genesis Theme Toolkit | ||
|
||
All notable changes to this project will be documented in this file. | ||
This project adheres to [Semantic Versioning](http://semver.org/). | ||
|
||
## [Unreleased] | ||
|
||
_Nothing yet._ | ||
|
||
## 0.1.0 - 2017-06-27 | ||
|
||
* Initial release. | ||
|
||
[Unreleased]: https://github.com/gamajo/genesis-theme-toolkit/compare/0.1.0...HEAD | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
nationality, personal appearance, race, religion, or sexual identity and | ||
orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2017 Gamajo | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# Genesis Theme Toolkit | ||
|
||
Building blocks to develop a config-based Genesis Framework child theme for WordPress. | ||
|
||
When building a theme, wouldn't it be nice to separate out the implementation-specific config, from the reusable logic? This is the premise upon which the [Using a Config to Write Reusable Code](https://www.alainschlesser.com/config-files-for-reusable-code/) series articles are written, and which this package enables. | ||
|
||
Specifically, this packages builds upon the [Theme Toolkit](https://github.com/gamajo/theme-toolkit) package, and adds _bricks_ that are specific to Genesis child theme development. It provides an easy way to: | ||
|
||
- Filtering the default Genesis breadcrumb arguments. | ||
- Registering and unregistering Genesis layouts. | ||
- Unregistering templates inherited from Genesis (extends Theme Toolkit functionality) | ||
- Filters Genesis theme settings defaults, or forces them to specific values. | ||
- Register and unregister widget areas, added by Genesis (extends Theme Toolkit functionality) | ||
|
||
## Installation | ||
|
||
In a terminal, browse to the directory with your theme in and then: | ||
|
||
~~~sh | ||
composer require gamajo/genesis-theme-toolkit | ||
~~~ | ||
|
||
You can then autoload (PSR-4) or require the files as needed. | ||
|
||
## Usage | ||
|
||
See the [example-config.php](docs/example-config.php). This would typically live in your theme, at `config/defaults.php`. | ||
|
||
Your theme would then contain a function, in the `functions.php`, to pull in this config, and load up the individual components, which are referred to as _bricks_: | ||
|
||
```php | ||
// functions.php | ||
|
||
namespace Gamajo\ExampleTheme; | ||
|
||
use BrightNucleus\Config\ConfigFactory; | ||
use Gamajo\GenesisThemeToolkit\BreadcrumbArgs; | ||
use Gamajo\GenesisThemeToolkit\Layouts; | ||
use Gamajo\GenesisThemeToolkit\Templates; | ||
use Gamajo\GenesisThemeToolkit\ThemeSettings; | ||
use Gamajo\GenesisThemeToolkit\WidgetAreas; | ||
use Gamajo\ThemeToolkit\GoogleFonts; | ||
use Gamajo\ThemeToolkit\ImageSizes; | ||
use Gamajo\ThemeToolkit\Templates; | ||
use Gamajo\ThemeToolkit\ThemeSupport; | ||
use Gamajo\ThemeToolkit\Widgets; | ||
use Gamajo\ThemeToolkit\WidgetAreas; | ||
|
||
add_action( 'after_setup_theme', __NAMESPACE__ . '\setup' ); | ||
/** | ||
* Theme setup. | ||
* | ||
* Compose the theme toolkit bricks. | ||
*/ | ||
function setup() { | ||
$config_file = __DIR__ . '/config/defaults.php'; | ||
$config = ConfigFactory::createSubConfig( $config_file, 'Gamajo\ExampleTheme' ); | ||
|
||
// These bricks are run in admin and front-end. | ||
$bricks = [ | ||
ImageSizes::class, | ||
Templates::class, | ||
ThemeSupport::class, | ||
Widgets::class, | ||
Layouts::class, | ||
ThemeSettings::class, | ||
WidgetAreas::class, | ||
]; | ||
|
||
// Apply logic in bricks, with configuration defined in config/defaults.php. | ||
array_walk( $bricks, ThemeToolkit::class . '::apply', $config ); | ||
|
||
|
||
if ( ! is_admin() ) { | ||
// Only front-end bricks. | ||
$bricks = [ | ||
BreadcrumbArgs::class, | ||
GoogleFonts::class, | ||
]; | ||
|
||
array_walk( $bricks, ThemeToolkit::class . '::apply', $config ); | ||
|
||
} | ||
} | ||
``` | ||
|
||
The `'Gamajo\ExampleTheme'` string matches the two keys in the `return` at the bottom of the config file. Change this in the config and the function to be your company name and theme name. | ||
|
||
You don't have to use all of the bricks in this package; pick and choose. | ||
|
||
You can add your own bricks to your theme (in your `src/` or similar directory), and then make use of them in the function above. | ||
|
||
If you're not using the Genesis Framework, see the [Theme Toolkit](https://github.com/gamajo/theme-toolkit) which has just the bricks applicable for building themes in general. | ||
|
||
## Change Log | ||
|
||
Please see [CHANGELOG.md](CHANGELOG.md). | ||
|
||
## Credits | ||
|
||
Built by [Gary Jones](https://twitter.com/GaryJ) | ||
Copyright 2017 [Gamajo](https://gamajo.com) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
{ | ||
"name": "gamajo/genesis-theme-toolkit", | ||
"type": "library", | ||
"description": "Building blocks for developing a config-based Genesis child theme for WordPress.", | ||
"keywords": [ | ||
"WordPress", | ||
"wordpress-theme-development", | ||
"genesis-framework" | ||
], | ||
"license": "MIT", | ||
"authors": [ | ||
{ | ||
"name": "Gary Jones", | ||
"homepage": "https://gamajo.com", | ||
"role": "Developer" | ||
} | ||
], | ||
"autoload": { | ||
"psr-4": { | ||
"Gamajo\\GenesisThemeToolkit\\": "src/" | ||
} | ||
}, | ||
"autoload-dev": { | ||
"psr-4": { | ||
"Gamajo\\GenesisThemeToolkit\\Tests\\": "tests/" | ||
} | ||
}, | ||
"require": { | ||
"php": "^7.0", | ||
"gamajo/theme-toolkit": "^0.3", | ||
"roave/security-advisories": "dev-master" | ||
}, | ||
"require-dev": { | ||
"brain/monkey": "^2", | ||
"phpunit/phpunit": "^6.1", | ||
"squizlabs/php_codesniffer": "^3.0.1" | ||
}, | ||
"config": { | ||
"sort-order": true | ||
}, | ||
"minimum-stability": "dev", | ||
"prefer-stable": true | ||
} |
Oops, something went wrong.