Installing this theme can be done in one of two ways. The 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.

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 gravstrap-theme

This will install this theme into your /user/themes directory within Grav. Its files can be found under /your/site/grav/user/themes/gravstrap-theme.

Permissions

One common issue when installing Grav is that its directory must be writable both by the web server and the command line user. On a UNIX system, if your web server user is different from your command line user who owns the files, you can try the following solution, running those commands from the root of your Grav project:

sudo setfacl -R -m u:"$HTTPDUSER":rwX -m u:whoami:rwX var
sudo setfacl -R -m u:"$HTTPDUSER":rwX -m u:whoami:rwX *
sudo setfacl -dR -m u:"$HTTPDUSER":rwX -m u:whoami:rwX *

Manual Installation

To install this theme, just download the latest release and unzip it under /your/site/grav/user/themes. Then, rename the folder to gravstrap-theme. You can find these files either via GetGrav.org.

You should now have all the theme files under

/your/site/grav/user/themes/gravstrap-theme

Mandatory and optional plugins

This theme requires the following mandatory plugins to work:

  • gravstrap
  • blog-injector
  • markdown-sections
  • simple_form
  • googlemaps

In addition you should also add these plugins:

  • simplesearch
  • feed
  • relatedpages
  • pagination
  • taxonomylist
  • archives

To install those dependencies run the following commands from a terminal:

bin/gpm install gravstrap
bin/gpm install blog-injector
bin/gpm install simple_form
bin/gpm install googlemaps

Updating

As development for this 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 this theme 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 gravstrap-theme

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

  • Delete the your/site/user/themes/gravstrap-theme directory.
  • Download the new version of the this theme from either via GetGrav.org.
  • Unzip the zip file in your/site/user/themes and rename the resulting folder to gravstrap-theme.
  • 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 this theme 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: gravstrap-theme.
  • Enable markdown extra parser adding the following configuration under the pages node:

    pages:
        [...]
        markdown:
            extra: true
  • Save your changes.

IMPORTANT: You must follow the next instructions to complete the set up, when you install from the Admin Panel.

Copy the user/plugins/blog-injector/blog-injector.yaml file to user/config/plugins/blog-injector.yaml, open that file and change the configuration as follows:

enabled: true
framework: bootstrap
add_default_css: true
add_framework_assets: false

Demo Contents

This theme comes with a _demo folder inside the theme directory, where you can find some page contents to your site. To add this pages to your Grav website, just backup your current pages if needed, then remove the site pages. Next, copy the pages from the _demo folder under your website pages folder and you are done.

Complete the setup

To complete the theme setup, you just need to 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 gravstrap-theme folder.