This is the Medium Rare Interactive Wordpress boiler theme. It provides the basic required WordPress template structure along with some handy functions and configuration that we use often. This is tied together with a scss/coffeescript hierarchy compiled with GULP based upon this Gist: https://gist.github.com/yosukehasumi/d21f3ed89171ea5fc234
If you are on Mac, Yosuke created a handy bash script that can create a new WP site for you from scratch, see his gist here: https://gist.github.com/yosukehasumi/d0c905da78229122e7c1bb34a0fc92a7
Updated: https://gist.github.com/nathanieltubb/43b86d3f056bf2b8148e21c7756bfece
- GULP
- SASS/SCSS
- CoffeeScript
- Zurb Foundation 6*
- Advanced Custom Fields
- UnderscoreJS
- Modernizr
- ImagesLoaded
- SlickJS
- Cycle2JS
- IsotopeJS
* This theme currently uses Foundation v6.3.x, while the current documentation on the Foundation site is for >= 6.4.x. There may be some discrepencies between these versions.
There are a couple branches for flavours of this boiler theme. As theme has matured there has been the need to also allow for some trimmed down versions.
- [master] is our current, everyday toolbox
- [foundation] is that same toolbox with the addion of the Foundation CSS/JS framework
- [bare-bones] has just the basic folder and template structure
- [original-build] harkens back to where it all began
Adding the following like to your wp-config.php or wp-config-local.php
will enabled / disable some select features that are otherwise configured
for the production environment.
$_ENV['MRI_ENVIRONMENT'] == 'development';
Here lies additional functions, filters and configuration files.
ACF field groups are exported as PHP code and entered in separate files here
to be included in the main functions.php file.
ACF field groups are also exported as JSON to allow collaborating developers to import the currect set of fields into the ACF GUI.
ACF field groups that need their own helper functions for displaying their content get their own respective files here.
This folder holds the compiled JS in site.js and site.min.js. The
non-minified JS is called when the $_ENV['MRI_ENVIRONMENT'] is set
to development. Otherwise the minified version is called when in production.
This is where we store third-party JS libraries we are not currently using in the project.
This folder contains JS libraries that must be compiled first, before any other libraries or custom JS scripts.
This is the folder where we place JS libraries we wish to include in our project.
This is a dynamic folder containing the interim compiled libraries. Do not edit these files directly!
This folder contains the custom site CoffeeScript which is compiled into the
site.js file in the parent folder.
Here we have the Zurb Foundation framework JS plugins. The plugins are separated
into enabled and disabled. Only plugins in the enabled folder are compiled
and loaded in the theme. When enabling a plugin look at the plugin file to see
if it depends on any foundation.util.*.js plugins and enable / disable those
as needed.
Foundation JS plugins that will be compiled and used by the theme.
Foundation JS plugins that will not be compiled.
Here lives the theme's SCSS stylesheets.
This is the main stylesheet that gets compiled into style.css in the theme
folder. Please stick to using logical SCSS partials to separate and organize
your stylesheets. Update this file to include the new partials and bear in mind
the order in which the partials are compiled.
This is the settings file used by the Zurb Foundation framework to override the default configuration of the framework.
Here we have the SCSS for the Zurb Foundation framework. It is made up of
multiple partials with functions that help compile all the various features.
It is not recommended to edit these files apart from the foundation.scss file.
This is the file that the Zurb Foundation framework is compiled from. Here you may choose which components you want to include. Comment out any that you are not using to help reduce the overall size of the theme's stylesheet. Also remember to enable/disable the related Foundation JS plugins.