grav/plugins/materializer

Grav Materializer Plugin

Materializer is a Grav plugin that can be used as a dependency for other themes and plugins to load the Materialize framework. The main purpose of this plugin is to allow the Materialize theme to depend on the Materializer's CSS/JS and to allow the plugin to be updated independently of the theme itself.

Rather than using the icon font that comes with the Materialize Framework, Materializer uses a newer, expanded icon font: Material Design Icons.

Installation

GPM Installation (Preferred)

The simplest way to install this plugin is via the Grav Package Manager (GPM). From the root of your Grav install type:

bin/gpm install materializer

Manual Installation

If for some reason you can't use GPM you can manually install this plugin. Download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to materializer.

You should now have all the plugin files under:

/your/site/grav/user/plugins/materializer

Usage

To best understand what the Materializer plugin provides, you should read through the original Materialize framework documentation.

Configuration

Materializer is enabled but not always loaded by default. You can change this behavior by setting always_load: true in the plugin's configuration. Simply copy the user/plugins/materializer/materializer.yaml into user/config/plugins/materializer.yaml and make your modifications.

enabled: true                   # Enable / Disable this plugin
always_load: false              # If set to `false` the Theme must have `public $load_materializer_plugin = true;` to add the CSS/JS
load_core_css: true             # Load the core `materializer.css` CSS file
load_core_js: true              # Load the core `materializer.js` JS file
mode: production                # If set to `production`, load minified CSS/JS
use_cdn: false                  # If set to `true` use CDN instead of local files