README

Raccoon Plugin is a WordPress plugin which allows you to easily manage WordPress theme features with a JSON or YAML configuration file.

Summary

• Dev requirements
• Installation
• After installation
• Manifest JSON or YAML file
• Documentation
• Third-part features

Dev requirements

For its development, Raccoon Plugin requires:

• PHP >= 5.6
• Composer
• WordPress >= 4.4

Installation

To install the Raccoon Plugin in your WordPress project, you can :

1. Clone the repository in your WordPress plugin directory : git clone https://github.com/hiwelo/raccoon-plugin.git

2. If your using Composer and an environment like Bedrock : composer require hiwelo/raccoon-plugin

If you want to install this plugin directly in your WordPress without Composer, I suggest you to install it in the Must-Use Plugins mu-plugins/ directory.

If you want to install this plugin with Composer, note that this package has a specific type (wordpress-muplugin) for a direct installation into the mu-plugins/ directory (like in Bedrock).

After installation

If the plugin is in the WordPress mu-plugins/ directory, you do not need to do something special to activate it. You just need to create a manifest.json file in your theme's root directory to use it.

If the plugin is in the WordPress plugins/ directory, do not forget to activate it in the WordPress admin panel and create the manifest.json file in your theme's root directory.

Manifest JSON or YAML file

Once you created the JSON or YAML file in your theme's root directory, you can use in this file all features described in this project's wiki.

Third-part features

Raccoon loves Bedrock

Bedrock is a WordPress boilerplate which create a better projet structure mainly with a new wp-content/ folder renamed app/. Bedrock use Composer and environments variables.

By example, Raccoon can use environments variables from Bedrocks to know the environment status (development, production, staging) and manage which debug informations has to be returned by the theme. If you don't use Bedrock, you can manually set environment status in the manifest.json file like this :

{
  "environment-status": "development"
}