IntelliJ Plugin for Grav
Clone or download
Dominik
Latest commit 2ee9bb5 Oct 14, 2018

README.md

Grav Support Plugin

This plugin helps to increase the development speed for Grav-based projects within for IntelliJ Community / Ultimate Edition and PhpStorm

Grav is a flat-file CMS and it's open source.

Grav version support: 1.2.4 - 1.6.*

Tested with:

  • PhpStorm 2018.2.*
  • IntelliJ IDEA Community 2017.2.*
  • IntelliJ IDEA Ultimate 2018.2.4

The plugin is available in the JetBrains Plugins Repository

Install

JetBrains Plugins Repository

Open the settings menu CTRL+ALT+S or File -> Settings and then go to Plugins. Click on the button Browse repositories and search for Grav Support. This way you will get notified if a new update is available!

GitHub Release

Download the latest plugin and install it via the settings menu: CTRL+ALT+S or File -> Settings and then search for Plugins -> Install plugins from disk

Configuration

If you create a new Grav project / module you will have all features enabled by default.

If you're using PhpStorm and opening a previous project you may have to enable the plugin for the current project. The plugin tries to detect a Grav project automatically and notifies the user accordingly. Otherwise open the Settings menu (CTRL+ALT+S) and go to Languages & Frameworks -> Grav and enable the plugin for the current project.

Features

(see the changelog for a complete list)

  • Create a Grav module (Community / Ultimate) or project (PhpStorm) using IntelliJ Wizard
  • Ability to download and install Grav from the Module Wizard
  • Special language file editor
  • Tool window to configure basic config files of Grav
  • Navigate to the related template file from a page content markdown file
  • Create specific configuration files for a theme in the theme directory (blueprints.yaml, THEME_NAME.yaml)
  • Recognition of basic Grav configuration files
  • Create new theme (Tools menu or context menu on a module)
  • Create SDK for Grav
  • Twig intentions

Screenshots

New Project

Tool Window

Language Editor

Requirements

The plugin requires IDEA Community / Ultimate Edition 2017.2.* or PhpStorm 2017.2.1. With Ultimate you have also PHP support.

Additional

You need a valid PHP installation on your machine. Php should be found in the PATH.

The plugin uses the scripts in the bin directory of Grav to offer the functionality Grav supports via those scripts.

Help

Supported Grav versions

Currently it's only possible to automatically download all listed Grav version mentioned at the beginning of this Readme directly via the project wizard of IntelliJ. However, it's possible to use any other Grav installation by manually selecting them in the wizard.

"Grav plugin 'devtools' is not installed"

If you get this error message: "Grav plugin 'devtools' is not installed" after using the plugin and creating a new theme then you should follow these steps:

Move into your newly created Grav project and type into the console:

$ bin/gpm install devtools

References:

Contribution

Support the plugin if you like it:

Implement features or fix bugs

Fork this repository to your own GitHub account and then clone it to your local device. Open a pull request with improvements.

Please read the IntelliJ Platform SDK Documentation on how to set up the development environment.

Reporting issue

If you find any issues, please report them directly by using the GitHub issue tracker instead of review comments.