crittermike / grav-plugin-twig-namespaces

A Grav CMS plugin for adding Twig namespaces

Twig namespaces Plugin

This README.md file should be modified to describe the features, installation, configuration, and general usage of this plugin.

The Twig namespaces Plugin is for Grav CMS. Enable twig namespacing

Installation

Installing the Twig namespaces plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.

GPM Installation (Preferred)

The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's terminal (also called the command line). From the root of your Grav install type:

bin/gpm install twig-namespaces

This will install the Twig namespaces plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/twig-namespaces.

Manual Installation

To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to twig-namespaces. You can find these files on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/twig-namespaces

NOTE: This plugin is a modular component for Grav which requires Grav and the Error and Problems to operate.

Configuration

Before configuring this plugin, you should copy the user/plugins/twig-namespaces/twig-namespaces.yaml to user/config/plugins/twig-namespaces.yaml and only edit that copy.

Here is the default configuration and an explanation of available options:

enabled: true
namespaces:  // Array of namespaces
  test:  // Namespace to be used in twig files as `@test`.
    paths:  // Array of paths 
      - path to folder containing twig files to be included in namespace
      - another path be included for namespaces

Usage

Describe how to use the plugin.

Credits

Did you incorporate third-party code? Want to thank somebody?

To Do

• Future plans, if any