Installation

Installing the "UIkit for Gantry5" atom on your website is a really simple process. You just need to follow the below instructions depending on the platform you are on.

Installing on Joomla

1. Download the uikit-atom.zip file.
2. UNZIP it on your computer. You will find two files and one folder - uikit.html.twig, uikit.yaml and uikit.
3. Copy the uikit.html.twig and uikit.yaml files to root/templates/TEMPLATE_DIR/custom/particles (if the particles folder does not exist, you will need to create it manually). Basically, this step is the same as the one described in the Creating a New Particle chapter in the Gantry 5 Documentation.
4. Copy the uikit folder to root/templates/TEMPLATE_DIR/custom.

The following video shows the above steps in details (watch it in Fullscreen and FullHD for better quality).

Installing on Wordpress

1. Download the uikit-atom.zip file.
2. UNZIP it on your computer. You will find two files and one folder - uikit.html.twig, uikit.yaml and uikit.
3. Copy the uikit.html.twig and uikit.yaml files to root/wp-content/themes/TEMPLATE_DIR/custom/particles (if the particles folder does not exist, you will need to create it manually). Basically, this step is the same as the one described in the Creating a New Particle chapter in the Gantry 5 Documentation.
4. Copy the uikit folder to root/wp-content/themes/TEMPLATE_DIR/custom.

The following video shows the above steps in details (watch it in Fullscreen and FullHD for better quality).

Installing on Grav CMS

1. Download the uikit-atom.zip file.
2. UNZIP it on your computer. You will find two files and one folder - uikit.html.twig, uikit.yaml and uikit.
3. Copy the uikit.html.twig and uikit.yaml files to root/user/data/gantry5/themes/THEME_DIR/particles/ (if the particles folder does not exist, you will need to create it manually). Basically, this step is the same as the one described in the Creating a New Particle chapter in the Gantry 5 Documentation.
4. Copy the uikit folder to root/user/data/gantry5/themes/THEME_DIR/.

The following video shows the above steps in details (watch it in Fullscreen and FullHD for better quality).

Usage

All particles by nature are really intuitive and easy to use. Also, most of the fields in the particle have a tooltip text that explains what it is about.

Regarding the UIkit Framework - just check their official website and play with the code snippets they provide for every feature and customize it so it fits your needs.

You might also want to watch the Demo Video, which shows some of the basic things you can do with UIkit.

Download

You can download all particles from our Download Section.