Skip to content

Plugin that displays the last modified date of a GRAV CMS page.

License

Notifications You must be signed in to change notification settings

fulltrucker/grav-plugin-modified-date

Repository files navigation

Modified Date Plugin

The Modified Date Plugin is for Grav CMS. Displays the last modified date of a page above or below the page content.

Installation

Installing the Modified Date plugin can be done in one of two ways, either on the command line from GitHub or manually by downloading the .zip version of the plugin.

Git Installation (Preferred)

The simplest way to install this plugin is via Git on the command line. In the /user/plugins directory your Grav install type:

$ git clone https://github.com/fulltrucker/grav-plugin-modified-date.git

This will clone the Modified Date plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/modified-date.

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 modified-date. You can find these files on GitHub.

You should now have all the plugin files under

/your/site/grav/user/plugins/modified-date

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

Here is an explanation of available configuration options:

enabled: true or false
pretext: The text that is displayed before the last modified date. Simple text field, can accept Twig and Markdown.
placement: Whether you want to display the modified date at the top or the bottom of the content.
page_types: The page templates (types) on which to display the modified date. This should display a list of all templates dynamically generated from the theme. The list will also include partials, it's adviseable to only select actual page templates.

Note that if you use the admin plugin, a file with your configuration, and named modified-date.yaml will be saved in the user/config/plugins/ folder once the configuration is saved in the admin. Also you can override the default options per-page:

title: 'My Page'
modified-date:
    enabled: false
    pretext: 'Last changed on'
    placement: top

To Do

  • Remove or hide template partials from page_types option list.
  • Move the page type check login from onPageContentRaw() to onPluginsInitialized() so it just doesn't even fire if we're not on the right page. Maybe even replace the isAdmin() check.
  • Figure out how to use a template file to append/prepend to the page content, rather than munging the entire content. This would seem cleaner.

About

Plugin that displays the last modified date of a GRAV CMS page.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages