Gantry Framework Documentation
CSS HTML Shell
Pull request Compare This branch is 228 commits behind gantry:develop.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
data
docs.gantry.org/config/plugins
images
localhost/config
pages
plugins
themes/gantry-learn
.dependencies
.editorconfig
.gitignore
LICENSE
README.md
hebe.json

README.md

Join the chat at https://gitter.im/gantry/gantry5

Gantry Documentation

This repository contains the source of the Gantry documentation, currently accessible at http://docs.gantry.org.

The documentation is contained in Pages/ and is structured in folders (chapters), exactly as you see them on the main website. The entirety of the repo found here is intended to act as the user/ folder in a Grav install. This repo contains themes, configuration files, and settings that enable the documentation to be presented in the way they do on the documentation site.

You can read all of the documentation within (as it's just in plain text files) marked up with Markdown.

In order to load a local copy and create working pages, we recommend checking out Grav's documentation as it will give you the information you need to understand the documentation file structure and syntax.

If you would like a local copy of the documentation, you can either download it or you can clone the repository by running the following command:

git clone git://github.com/gantry/docs gantry-docs

Contributing

Contributing to the documentation is very simple. Feel free to fork the repository, add your changes and give back by issuing a pull request. You can even edit the docs directly on GitHub, without having to ever download the files. Make sure to follow the conventions before issuing a pull request.

You are also very welcome to make any suggestions or report any kind of problem with the documentation by opening a new Issue.

If you decide to fork for providing new content as commits. Please ensure you create a branch for your changes, before making them. This will make the process of integrating them more easier. Every change must pass through the develop branch first, so please ensure your pull-requests are directed to the proper branch.

To get started with a local environment into the proper develop branch, you can run these commands:

git clone git://github.com/gantry/docs gantry-docs
cd gantry-docs
git checkout -b develop origin/develop

Conventions

This is a list of few conventions we follow when writing documentation that help keep the repository well organized and consistent. Feel free to use any other file in the docs as reference.

  • Every change/pull request must be applied or requested to the develop branch. Once reviewed, approved and pulled, it will get merged into the master branch and automatically picked up by the website.

  • Folder and file names must be written in lisp-case (dash concatenated) and always lowercase. For example, if you wanted to convert “How to Install” in lisp-case, you would name it “how-to-install”.

  • Every header, except for the title one, must be preceded by 2 empty lines and succeeded by no empty line.

  • Headers sub lines (= and -) must always align to the header text. Because this can easily get confusing, be sure to use a mono-spaced fonts. Here a couple of examples of well aligned headers:

    Header H1
    =========
    
    Header H2
    ---------
    

YAML Headers

Our Markdown implementation uses special YAML headers. These headers are encapsulated in between a set of three dashes and an empty line. This is how a YAML header looks like:

---
title: Getting Started
taxonomy:
    category: docs
    tag: [gantry5]
gravui:
    enabled: true
    tabs: true
    callouts: true
process:
    twig: true
---

The headers allow for a much flexible output. For example we can define a title of a Markdown file based on its header title variable, rather than the file name itself.

Below is a list of supported YAML variables that can be used and a description on what they do:

  • title: The title of the article. This is used whenever a page needs to be referenced. When the title is set on a TOC file, it globalize the title for each document in the project itself.

    ---
    title: Hello World!
    
    ---
  • taxonomy: sets the type of article, and its tags. By default, any documentation file should have category: docs and tag: [gantry(version)] settings.

    The description supports Markdown inline syntax, such as strong, italic, links. You should not be using anything else (ie, headers, images and such).

    ---
    taxonomy:
        category: docs
        tag: [gantry5]
    
    ---
  • gravui: These settings give you the ability to load specific gravui patterns.

    The supported gravui settings are listed below:

    • enabled: Sets whether or not gravui is used at all during page rendering. This is most likely to be enabled: true.
    • tabs: When set to true this enables the use of tabs to differentiate between commands that are exclusive to one CMS or another. This defaults to false if the line isn't present.
    • callouts: When set to true, this enables visual callouts to be placed over an image. This is a useful tool when you want to point something out in the image, and provide a tooltip that appears when you move your mouse cursor over it.
  • process: Process tags give you the ability to do things like inject Twig script within the markdown file, and have it execute. This comes in handy when you are doing things like adding classes to images to give them an enhanced appearance. For example, {.border .shadow} after a markdown image will apply the border and shadow classes, giving your image a more refined appearance.

    Here is a more complete example of a line in documentation with Twig:

    ![Administrator](../../configure/gantry-admin/admin_access_1.png) {.border .shadow}

If you have any questions, feel free to open an Issue.

The RocketTheme Team