Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Editor Plugin

The Editor Plugin is for Grav CMS. Edit your Grav source files directly from the browser. CSS, Twig, JS, and PHP are supported.

Installation

Installing the Editor 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 editor

This will install the Editor plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/editor.

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 editor. 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/editor

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/editor/editor.yaml to user/config/plugins/editor.yaml and only edit that copy.

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

enabled: true

Usage

To edit CSS files, you must be logged in as administrator or superuser.

  • Navigate to /editor. You will see a list of CSS folders for each installed theme.
  • Select the CSS file you want to edit.
  • An editor page will open allowing you to make changes.
  • Press Save to update the file.

See Official Documentation.

Credits

Thanks to Grav and CodeMirror for sweet products and platforms.

To Do

  • Compare changes.
  • Use code-mirror editor.
  • Confirm save.
  • Optimistic locking.
  • Create files.
  • Delete files .
  • Create folders.
  • Delete folders.
  • Enable / disable languages.
  • Put languages in dropdown menu.
  • Remove code-mirror dependency.
  • Pretty print.
  • Refactor snackbar.
  • Refactor fast-filter.