This folder contains Jekyll data files, which are used for controlling certain contents in your website. This includes files for ordering the navigation menus, images in the gallery, and for working with and publishing event information to your Web pages and other applications. It contains a number of different types of files (see § Files in this folder) including both published artifacts and work-in-progress.
README.md
- This help file. :)contact_info.yaml
- Your contact information, such as you telephone number and physical address.gallery.yaml
- Description of which images to display on your site's gallery, and in what order.opening_hours.yaml
- Listing of your business's opening hours.menus.yml
- Description of which pages to link to from the navigation menus.
In addition to these files, this folder also contains the following subfolders:
- strings - Localized translations for various human-language text in your Web site's templates. See Internationalization and Localization for details.
It is easy to change the contact information displayed on your website simply by changing the content of this file. Each line in this file contains a part of your contact information. For example:
---
street_address: 123 Main Street
extended_street_address: Unit 2
locality: Pleasantville
region: NY
postal_code: 12345
telephone: +1-555-123-4567
email: mybusiness@example.com
Each line is relatively self-explanatory, in that the line that begins with email:
determines your main contact email address. To change your email address, simply change the email address value.
Your site includes a customizable gallery. To add an image to your site's gallery, first upload the image to your site's static/images
folder. Once uploaded, it can be referenced from the gallery.yaml
data file (in this folder). By editing the gallery.yaml
file, you can control which uploaded images are included in your website's gallery, write captions for the images, make the images into clickable links, and more.
The gallery.yaml
file is written in a structured format called YAML. When you edit YAML files, be careful to maintain the structure of the file (i.e., match the indentation and punctuation style as in the rest of the file).
Your gallery images are represented as a single YAML list. Each item in the list (a dash on its own line) represents an image in the gallery. Each image in the gallery has, at a minimum, an image
field, whose value should be the name of an image file in your site's static/images
folder. You may also specify the following optional fields for each image:
alt
- Brief textual description of the image, usually no more than a sentence or two. For example,Sunset on a sand beach over calm waters.
This text is usually not displayed visually but provides a gracefully degrading fallback in case of a network error, as well as important accessibility benefits for browsers with visual impairments, including humans as well as bots.caption
- A caption for the image. This accompanies the image as visually rendered text somewhere near the image itself. HTML is allowed in this field.link
- A Web address (URL) to use as the destination of the link this image will become. Omit this field if you do not want the image to be a link.link_title
- Thetitle
attribute text of the image's link. This text is usually displayed as a tooltip when a visitor hovers their mouse cursor over the image. This field is ignored unlesslink
is also set.featured
- Whether or not the image should be included on the front ("home") page. The only valid value istrue
; omit this field if you do not want to include the image on the front page.object_position
- Used to tweak the cropped position of non-standard image dimensions.
The menus.yml
data file defines the name, order, and contents of your site's navigation menus. Behind the scenes, it uses Forestry's Jekyll Menus plugin if that plugin is available, but will also fallback to using plain Liquid templates to render the menus if necessary. In either case, configuring a menu is done the same way.
Each menu has a name, such as main
or sidebar
. Each menu is composed of a single list, where each item in the list describes a single menu item. At a minimum, each menu item must include a url
, title
, and identifier
field. On multi-lingual sites, each menu item must also include a lang
field.
Optionally, menu items may also include the following fields:
title_text
- Thetitle
attribute's text for the link.image
- The name of an image file in your site'sstatic/images
folder. Omit this field to create a textual navigation menu item.weight
- Defines the order in which the menu items are shown in the menu, with1
being the first,2
being next, and so on.
If your site's hosting environment supports the Jekyll Menus plugin, you can also make use of any of the Jekyll Menu plugin variables as well.
The opening_hours.yaml
file is where you can edit your venue or business's opening hours (business hours). This file contains lines for each each of the week with an opening time and an ending time, like this:
Sunday:
open: "08:00"
close: "19:00"
Monday:
open: "07:00"
close: "19:00"
The above denotes that the business is open only on Sundays from 8 AM to 5 PM and Mondays from 7 AM to 5 PM. During other times, the business is considered closed.
If your business has non-standard opening and closing hours, you can use the text
field to describe it. For example:
Monday:
text: "By appointment only."
This maps to the Schema.org openingHours property.