tranduyhung / grav-theme-big-picture

Big Picture theme is a port of Big Picture by HTML5 UP for Grav CMS
MIT License
15 stars 12 forks source link

Big Picture theme for Grav CMS

Big Picture Theme screenshot

Big Picture theme is a port of Big Picture by HTML5 UP.

Demo

You can find a demo of the theme at grav-theme-big-picture.flatfiledeveloper.com.

Features

Installation

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 big-picture

This will install the Gateway theme into your /user/themes directory within Grav. Its files can be found under /your/site/grav/user/themes/big-picture.

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 big-picture.

You should now have all the theme files under

/your/site/grav/user/themes/big-picture

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

Setup

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

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 big-picture folder.

Configuration with Admin plugin

If you have Admin plugin installed, you can fully manage the sub-pages via Admin plugin.

Navigation Buttons

To have navigation button for each section, the folder name of your home page must be home, in its modular.md file you need to setup the custom ordering of your modular pages. Here is an example:

title: Home
content:
    items: '@self.modular'
    order:
        by: default
        dir: asc
        custom:
            - _intro
            - _what-i-do
            - _who-i-am
            - _my-work
            - _contact

Updating

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 big-picture

This command will check your Grav install to see if your Gateway 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 Big Picture is pretty simple. Here is what you will need to do to get this done:

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.