WordPress plugin to create timelines and display achievements in a chronological way.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
classes
languages
libraries
templates
.gitignore Adding ultra simple Gutenberg block to display a timeline. Oct 17, 2018
HOOKS.md
LICENSE.md
README.md
autoloader.php
composer.json
composer.lock
functions.php
phpcs.xml.dist
wp-timeliner.php

README.md

WP Timeliner PRs Welcome

Easily create timelines in WordPress and display achievements in a chronological way.

Display your timelines via a Gutenberg block, via a shortcode or using the Timeline taxonomy archive page.

This plugin provides lots of hooks and an extensible theming system to let developers extend it and customize it.

Philosophy

The plugin creates a new "Achievement" post type, alongside with a new "Timeline" taxonomy. Achievements are assigned to a timeline term, allowing them to be grouped together on a specific timeline.

Displaying a timeline can whether be done:

  • manually via a Gutenberg block anywhere on your site,
  • automatically via each Timeline term archive page where achievements will be displayed chronologically (disabled by default but can be enabled via plugins settings page)

Getting Started

Installing

Via composer

Add this GitHub repository to the list of available repos and install the plugin:

composer config repositories.pskli git https://github.com/psaikali/wp-timeliner.git
composer require pskli/wp-timeliner

Via Git

Clone this repository in your wp-content folder and you're good to go!

cd path/to/wp-content
git clone git@github.com:psaikali/wp-timeliner.git

Via WordPress.org (soon)

Not available yet. Check back soon!

Documentation

Please head to our wiki in order to learn how to use and extend WP Timeliner plugin.

Built with

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU License - see the LICENSE.md file for details