/grav-theme-bootstrap4

Primary LanguageTwigMIT LicenseMIT

Bootstrap4

Bootstrap

Bootstrap4 theme is a Grav theme that is based on version 4 of the popular Bootstrap framework.

Installation

Installing the Bootstrap4 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.

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 bootstrap4

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

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 bootstrap4. 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/bootstrap4

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

Updating

As development for the Bootstrap4 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 Bootstrap4 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 bootstrap4

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

  • Delete the your/site/user/themes/bootstrap4 directory.
  • Downalod the new version of the Bootstrap4 theme from either GitHub or GetGrav.org.
  • Unzip the zip file in your/site/user/themes and rename the resulting folder to bootstrap4.
  • 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.

Dependencies

The Bootstrap4 theme now depends on the Bootstrapper plugin to provide the appropriate CSS and JS. If you install via GPM, you should be prompted to also install this plugin. If not you should manually install via:

bin/gpm install bootstrapper

Setup

If you want to set Bootstrap4 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: bootstrap4.
  • 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 bootstrap4 folder.