The Timeline-plugin is for Grav CMS, and lets you create and manage timelines in an ordered, hierarchical manner. Timelines can be nested within each other, minutely customized on a page-level, and further customized with your own templates and styles. A demo is available, and demo content can be found in /pages.
Installing the Timeline-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 timeline
This will install the Timeline-plugin into your
/user/plugins directory within Grav. Its files can be found under
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
timeline. You can find these files on GitHub or via GetGrav.org.
You should now have all the plugin files under
Before configuring this plugin, you should copy the user/plugins/timeline/timeline.yaml to user/config/plugins/timeline.yaml and only edit that copy.
Here is the default configuration and an explanation of available options:
enabled: true language: en order: by: date dir: asc cache: native truncate: 100
Settings and Usage
||Enables or disables the plugin.|
|language||en||string (2)||Any two-letter (ISO-639-1) language code.|
||Orders pages according to date, title, or folder-name.|
||Order pages ascending or descending.|
||Where to store plugin's internal data.|
|truncate||100||int or boolean||Limits the amount of words in each note, to an integer or boolean state for default (100).|
||Enables or disables Linked Data output.|
|inject_timeline||null||string||Route to page to inject.|
||Inject page as timeline-period if true, only events if false.|
Each timeline is structured with a Header (timeline.md, Timeline-template) and Events (timeline_event.md, Timeline Event-template). Headers are used as separators and can order their descendant Events, as well as contain normal fields such as
content. Events also render a formatted, localized
locale), as well as an
image. In addition, Events are cast as Linked Data with JSON-LD, wherein
region are used.
Timelines can be mixed together from different locations in
/user/pages by using the
inject_timeline-field. Point it to a route (not path) where another timeline exists, and it will be added at the end of the current timeline. This can be done from any page that is a timeline, but not from an event. Use
inject_period to designate that the page itself should be included, to demarcate a new period immediately following the timeline it was injected from.
Two modes of printing are supported: Pure TexT or Graphics.
By default, graphics are included, and the layout will typically emulate mobile-view. Events will not alternate between odd and even.
To print pure text, remove the
<div class="print timeline-wrapper col-12 col-sm-10 col-sm-offset-1 col-md-8 offset-md-2"> in timeline.html.twig.
Use a SCSS-compiler, like LibSass, eg. node-sass and compile
assets/timeline.css in the plugin-folder. For example:
node-sass --watch --source-map true assets/timeline.scss assets/timeline.css.