nmathar / grav-theme-twentyfifteen

TwentyFifteen Theme for Grav

TwentyFifteen Theme for Grav

Twenty Fifteen by WordPress.org is a Grav conversion of 2015 most popular Wordpress theme. This theme is clean, blog-focused, and designed for clarity. Twenty Fifteen's simple, straightforward typography is readable on a wide variety of screen sizes, and suitable for multiple languages. We designed it using a mobile-first approach, meaning your content takes center-stage, regardless of whether your visitors arrive by smartphone, tablet, laptop, or desktop computer.

Features

• Mobile-first, Responsive Layout
• Custom Colors
• Custom Header
• Social Links
• Customizable options through admin interface
• 5 Predefined Color Schemes
• MultiLanguage support
• Archives plugin support
• Search plugin support
• RelatedPages plugin support
• TaxonomyList plugin support
• Feeds
• The GPL v2.0 or later license. :) Use it to make something cool.

Installation

Installing the TwentyFifteen theme can be done in one of two ways. Our GPM (Grav Package Manager) installation method enables you to quickly and easily install the theme with a simple terminal command, while the manual method enables you to do so via a zip file.

The theme by itself is useful, but you may have an easier time getting up and running by installing a skeleton. The TwentyFifteen Site Skeleton is a self-contained repository for a complete sites which includes: sample content, configuration, theme, and plugins.

GPM Installation (Preferred)

The simplest way to install this theme 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 twentyfifteen

This will install the TwentyFifteen theme into your /user/themes directory within Grav. Its files can be found under /your/site/grav/user/themes/twentyfifteen.

Manual Installation

To install this theme, just download the zip version of this repository and unzip it under /your/site/grav/user/themes. Then, rename the folder to twentyfifteen. You can find these files either on GitHub or via GetGrav.org.

You should now have all the theme files under

/your/site/grav/user/themes/twentyfifteen

NOTE: This theme is a modular component for Grav which requires the Grav, Error and Problems plugins.

Updating

As development for the TwentyFifteen theme continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating TwentyFifteen is easy, and can be done through Grav's GPM system, as well as manually.

GPM Update (Preferred)

The simplest way to update this theme is via the Grav Package Manager (GPM). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:

bin/gpm update twentyfifteen

This command will check your Grav install to see if your TwentyFifteen theme is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type y and hit enter. The theme will automatically update and clear Grav's cache.

Manual Update

Manually updating TwentyFifteen is pretty simple. Here is what you will need to do to get this done:

• Delete the your/site/user/themes/twentyfifteen directory.
• Download the new version of the TwentyFifteen theme from either GitHub or GetGrav.org.
• Unzip the zip file in your/site/user/themes and rename the resulting folder to twentyfifteen.
• Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in terminal and typing bin/grav clear-cache.

Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in user/config/themes) will remain intact.

Setup

If you want to set TwentyFifteen as the default theme, you can do so by following these steps:

• Navigate to /your/site/grav/user/config.
• Open the system.yaml file.
• Change the theme: setting to theme: twentyfifteen.
• Save your changes.
• Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in Terminal and typing bin/grav clear-cache.

Once this is done, you should be able to see the new theme on the frontend. Keep in mind any customizations made to the previous theme will not be reflected as all of the theme and templating information is now being pulled from the twentyfifteen folder.