Getting Started

Ready to get started with Gantry 5? That's great! We are here to help.

On this page, you will get some quick tips to help you hit the ground running with Gantry 5. You can find more detailed documentation for each of these tips by clicking the Learn More button at the bottom of each section.

We hope you enjoy Gantry 5 every bit as much as we have enjoyed making it.

Installing Gantry 5 and the Helium Theme

Gantry 5 is a framework by which Gantry-powered themes are made. In order for a Gantry theme to work, you will need to install both the framework and the theme. Doing this is not difficult at all.

The first thing you need to do is download the latest build of Gantry 5 and Helium. You can do so by clicking the buttons below, or via GitHub.

Download Gantry 5 and the Helium Theme

Once you have the latest packages, installation is simple. We have provided a step-by-step guide in the Installation portion of this documentation.

Learn More

Accessing the Gantry Administrator

Administrator

When you have installed and activated both the Gantry framework and your Gantry-powered theme, you can access the Gantry 5 administrator in several different ways. The easiest being simply navigating to Components → Gantry 5 Templates from the back end of Joomla.

Here, you will see a list of any installed Gantry-powered themes. You can Preview the theme from here or select Configure to go directly to the Gantry Administrator where you can get started modifying your Gantry-powered site.

Administrator

Accessing the Gantry 5 administrator is pretty easy. Once you have both Gantry and your desired Gantry-powered theme installed and activated, you can simply select (Theme Name) Theme from the sidebar in the backend.

Accessing the Gantry 5 administrator in Grav is easy. Simply log in to the Grav Admin and select Gantry in the sidebar. Once here, you can choose the Gantry 5 theme you wish to configure by clicking the Configure button.

Navigating the Gantry 5 Administrator

The Gantry Administrator has multiple administrative tools you can flip through to configure how your Gantry-powered theme looks and functions. Here is a quick breakdown of each of these tools, and what you can do with them.

1
2
3
4
5
6
7
8
9
  1. Outlines: This administrative panel lists displays the current theme's outlines, giving you quick access to edit, rename, duplicate, and delete them.

  2. Menu Editor: This administrative panel gives you the ability to enhance the platform's menu by altering styling, rearranging links, and creating menu items that sit outside of the CMS's integrated Menu Manager.

  3. About: This page gives you quick, at-a-glance information about the currently-accessed theme. This is a one-stop shop for information about the theme including: name, version number, creator, support links, features, and more.

  4. Extras: This button opens a dropdown that gives you access to Clear Cache and Platform Settings functionality.

  5. Outlines Dropdown: This dropdown displays various outlines associated with your site. You can use it to quickly switch between them to edit their individual settings.

  6. Styles (Pictured): The Styles administrative panel gives you access to style-related settings for the outline. This includes things like theme colors, fonts, style presets, and more.

  7. Settings: The Settings administrative panel offers you the ability to configure the functional settings of the theme. This includes setting defaults for Particles, as well as enabling/disabling individual Particles.

  8. Layout: The Layout administrative panel is where you would configure the layout for your theme. Creating an placing module positions, Particles, spacers, and non-rendered scripts such as Google Analytics code is all done in this panel.

  9. Assignments : The Assignments administrative panel only appears on child outlines which can be assigned to specific areas of your site. If you are in the Base Outline, you will not see this administrative panel as it can't be assigned.

Learn More

What are Outlines, Particles, Atoms, etc.?

Because Gantry 5 is so different from any version of Gantry before it, we came up with some terms to help make sense of the relationships Gantry's new features have with one-another. Here is a quick breakdown of commonly used terms related to Gantry 5.

Term Definition
Outline A configurable style used in one or more areas of your site. It serves as the container on which a page's style, settings, and layout are set.
Particle A typically small block of data used on the front end. It acts a lot like a widget/module, but can be easily configured in the Gantry 5 Administrator.
Atom A type of Particle that contains non-rendered data, such as custom scripting (JS, CSS, etc.) or analytics scripts for traffic tracking.

Learn More

Where to Get Help

A chat room has been set up using Gitter where you can go to talk about the project with developers, contributors, and other members of the community. This is the best place to go to get quick tips and discuss features with others.