Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
css
 
 
 
 
js
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Tikva

Tikva

The Tikva Theme is for Grav CMS. Tikva is a minimalistic Grav theme, based on Bootstrap 4 framework.

Installation

Installing the Tikva 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 to provide a documentation 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 Tikva

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

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

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

Updating

As development for the Tikva 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 Tikva 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 tikva

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

  • Delete the your/site/user/themes/tikva directory.
  • Download the new version of the Tikva theme from either GitHub or GetGrav.org.
  • Unzip the zip file in your/site/user/themes and rename the resulting folder to Tikva.
  • 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
  • Flexible footer and sub-footer handling
  • Predefined and custom social media site buttons

Setup

If you want to set Tikva 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: tikva.
  • 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. Since version 0.1.1 the configuration options are splitted into tabs. You'll find the global or general options in the first tab, the footer and sub-footer options in the second tab and the Social Media settings beside it.

Footer support

Most websites need a special area at the bottom with common contents - the footer. The Tikva 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 publish, so please switch the "published" option to "no" and save the page.

At last, create the content area pages.

As parent page use the previously created "footer" folder. The page template should be "footer". After finished you can edit the footer sections in the same manner as you edit pages.

General Options

Tikva offers 25 themes! Most of them 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.

  • navbar.fixed_top: true/false - Navigation bar fixed to top or place it in a classical way after the site logo and title

  • navbar.navigation.alignment: - left (default), center, right: Navigation bar text alignment

  • 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

  • dropdown.enable_mouseover: true/false - Show dropdown on mouseover. Warning - this breaks the ability to handle the responsive feature of the theme. The theme uses Bootstrap v4 framework, and per default there is no option to drop a menu automatically on mouseover. So it is not recommended to activate this option.

  • 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/:

  • background.color: Background color. If color is set, it will be used for background. Set empty for default.
  • background.image: Background image upload feature. The images will be stored in the folder 'user/pages/images/bg'
  • background.repeat: Background image repeat options. Default "repeat", this enables repetition in both directions. Possible values: repeat-x (horizontally), repeat-y (vertically) and no-repeat (no repetition).

Footer Options

  • footer.color_fg: Choose the foreground, i.e. text color used in the footer.
  • footer.color_link: Choose the link color
  • footer.color_bg: Choose the background color used in the footer.

Subfooter Options

  • subfooter.enabled: true/false: Show the content below the footer.
  • subfooter.color_fg: Choose the foreground, i.e. text color used in the subfooter.
  • subfooter.color_link: Choose the link color
  • subfooter.color_bg: Choose the background color used in the subfooter.
  • 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.

Social Media Settings

Options

In the first Social Media tab you can set generic options:

  • socialmedia.buttons.enabled: true/false: Show Social Media Buttons
  • socialmedia.buttons.position: Choose position of the buttons
  • socialmedia.buttons.alignment: Choose button alignment (left, center, right)
  • socialmedia.buttons.size: Button Size (small, medium, large)
  • socialmedia.buttons.type: Button Type (circle, square)
  • socialmedia.color.fg: Button Foreground (Icon) Color
  • socialmedia.color.bg: Button Background Color
  • socialmedia.color.bg_mouseover: Button Background Mouseover Color

Social Media Buttons

In the second tab you can add preconfigured and custom Social Media sites.

For Facebook, LinkedIn etc. just add your profile URL.

For custom sites, you have to add the site name, Font Awesome Icon and the page URL. You can add as many buttons as you want.

Slider

Tikva supports an image slider, which is a component of Bootstrap framework. The slider is fully configurable by the admin plugin, so it's strong recommended to use it. In the first tab you will find the generic options to configure the slider. You can switch in on or off and choose the place where the slider will be displayed.

Usage: The slider is embeddable in every page. To enable the slider view, please choose the page template "Default with slider". You can switch the slider on and off in the slider options, but without choosing the right page template, it will never be displayed.

Options

  • slider.enabled: true/false - Show Slider
  • slider.position: Slider position, the possible values are: 1: Above navigation (if navbar position is not fixed) 2: Between navigation and content 3: Between content and footer
  • slider.width: Width of slider images. Set '0' for no resizing. It is recommended to use an appropriate image size of the slider images, e.g. 1920x500px when uploading the slider images. The slider images are not resized automatically, but it's possible to set a width with this option. This works in combination with the next setting "Preserve ratio".
  • slider.height: Height of slider images. Set '0' for no resizing. It is recommended to use an appropriate image size of the slider images, e.g. 1920x500px when uploading the slider images. The slider images are not resized automatically, but it's possible to set a height with this option. This works in combination with the next setting "Preserve ratio".
  • slider.preserve_ratio: true/false - Preserve ratio of slider images
  • slider.interval: Transition delay. Number of milliseconds a photo is displayed for (enter 0 for no automatically cycling), default 5000
  • slider.pause.pause: Pause sliding on mouseenter
  • slider.keyboard.keyboard: Slider reacts to keyboard events
  • slider.wrap.wrap: Cycle continuously

Items

The slider items (images) are stored in a list, so you can add as many as you want. The itemss can be configured by the following fields:

  • .title: Title
  • .image: Image upload with filesystem destination: 'user/pages/images/slider'
  • .description: The description and title are displayed in the bottom of the image content.
  • .alignment: Alignment, valid input is "left", "centered" or "right" to place the title and description
  • .text_color: Text color for title and description, default: transparent, i.e. use color defined in the theme stylesheet
  • .page: The page which will be linked to. Choose "unset" to disable.
  • .url: Enter URL to link to. Leave empty if this should not be used. The .url setting overwrites the .page option.

Thanks

About

Tikva is a minimalistic Grav theme, based on Bootstrap 4 framework.

Resources

License

Packages

No packages published