Skip to content

A simple, blog-oriented Grav theme based on Bootstrap 4

License

Notifications You must be signed in to change notification settings

cleinias/blogstrap4

Repository files navigation

Blogstrap4

Blogstrap4 is a minimalistic theme is for Grav CMS based on the Bootstrap 4 framework.

Installation

Installing the Blogstrap4 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 is designed to be used for a blog site. You can see this in action at

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 Blogstrap4

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

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 blostrap4. 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/blogstrap4

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

Updating

As development for the Blogstrap4 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 Blogstrap4 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 blogstrap4

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

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

Features

  • Preinstalled [Bootswatch|(https://bootswatch.com/) Bootstrap 4 themes
  • Lightweight and minimal for optimal performance

Setup

If you want to set Blogstrap4 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: blogstrap4.
  • 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 tikva folder.

Configuration options

You can reach all configuration options in the admin interface, so it's recommended to use it.

Footer support

Most websites need a special area at the bottom with common contents - the footer. The Blogstrap4 theme supports this in a flexible, but simple manner. In the admin interface (or by the option "footer.columns") you can set the number of columns the footer should have. Due to Bootstrap's grid system you can choose between 1, 2, 3, 4 or 6 columns.

Every column is represented by a special page, so the content can be edited with the usual interfaces (or with the help of a text/markdown editor).

The simplest way to create the footer is to use the admin user interface.

At first, create a folder named "footer" in the page area.

The name is important, so please use the folder name "footer". This folder must not be published, so please switch the "published" option to "no" and save the page.

At last, create the content area pages.

Use the previously created "footer" folder as parent page. The page template should be "footer". Once you are finished you can edit the footer sections in the same manner as you edit other pages.

Predefined themes

Blogstrap4 offers 22 themes! They originate in Bootswatch by Thomas Park. But you can also customize header and footer settings by the following options.

  • navbar.invert: true/false - Invert navigation bar. This changes the text color.
  • navbar.background: Choose between seven options, in Bootstrap they are described as ".bg- * utils".
  • navbar.background_color: If the previous option is not enough, you can pick your own color.
  • footer.color_fg: Choose the foreground, i.e. text color used in the footer.
  • footer.color_bg: Choose the background color used in the footer.

Miscellaneous Settings

  • theme.adjust_header: Adjust header by adding a distance between navigation and content. Some of the styles need more space, so you can use this option to adjust. As an example, to add 20 pixel, enter "20", the value has to be numeric.

  • dropdown.enabled: true/false - show dropdown links in navigation

  • theme.file_logo: Logo image in header.

  • favicon_file: Change the favicon by uploading your own.

Both image files have to be stored in a folder in user/pages/images/:

  • subfooter.enabled: true/false: Show the content below the footer.
  • subfooter.content: This is the content of the subfooter area. The default value is a hint to Grav CMS and the theme, but you can modify the content fitting your needs.

Thanks

About

A simple, blog-oriented Grav theme based on Bootstrap 4

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published