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
js
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 

Build Status

Lazysizes Plugin

The Lazysizes Plugin provides support for lazyloading images defined in the markdown of a page. Instead of manipulating the rendered content it extends the markdown parser and wont't work with editors that are not using the Grav Parsedown Parser, like tinymce-editor for example.

Installation

Installing the Lazysizes plugin can be done in one of three ways: The GPM (Grav Package Manager) installation method lets you quickly install the plugin with a simple terminal command, the manual method lets you do so via a zip file, and the admin method lets you do so via the Admin Plugin.

GPM Installation (Preferred)

To install the plugin via the GPM, through your system's terminal (also called the command line), navigate to the root of your Grav-installation, and enter:

bin/gpm install lazysizes

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

Manual Installation

To install the plugin manually, download the zip-version of this repository and unzip it under /your/site/grav/user/plugins. Then rename the folder to lazysizes. 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/lazysizes

NOTE: This plugin is a modular component for Grav which may require other plugins to operate, please see its blueprints.yaml-file on GitHub.

Admin Plugin

If you use the Admin Plugin, you can install the plugin directly by browsing the Plugins-menu and clicking on the Add button.

Configuration

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

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

enabled: true

Note that if you use the Admin Plugin, a file with your configuration named lazysizes.yaml will be saved in the user/config/plugins/-folder once the configuration is saved in the Admin.

About

Adds lazyloading to page images

Topics

Resources

License

Packages

No packages published

Languages