Turbo Broccoli

Configuration

Table of Contents

This page outlines the configuration options available in _config.yml.

Title

title: Turbo Broccoli

Sets the title of the site. This title is displayed in the browser tab and the footer of the page.

Author

author: aensley

Declares the author of the page. Used in the SEO meta tags in the HTML <head> section.

Description

description: >
  A Jekyll theme for GitHub Pages. It's fast, and it's good for you.

Sets the description of the site. This is displayed in the footer.

footer: >
  Footer goes here.

Sets the footer content.

menus:
 - Features

Sets the menus available in the header navbar.

header_links:
  - text: Issues
    link: https://github.com/aensley/turbo-broccoli/issues/
    icon: fas fa-tasks
  - text: Donate
    link: https://andrewensley.com/donate/
    icon: fas fa-donate

Custom header links displayed on the right side of the header navbar next to Search.

Bootswatch Theme

bootswatch_theme: materia

Sets the Bootswatch Theme of the site. See the Themes page for available options.

Theme Color

theme_color: "#18bc9c"

Sets the primary color used in the site icon.

Logo Image

logo_image: 1

Set/uncomment this when you have created the site’s logo files.

banner_image: /assets/media/banner.png

Uncomment and set to the path of a banner image to display at the top of every page.

Maximum displayed width is 825px. Transparent PNG or GIF recommended.

The beginning slash (representing site-/repo-root) is required.

Date Format

date_format: "%b %-d, %Y"

Date format. See: http://shopify.github.io/liquid/filters/date/

Scroll Past Content

sroll_past_content: 1

Set/uncomment this to enable scrolling past page content. This is useful to ensure anchor links scroll to anchors at the bottom of the content.

Search API

api_token: 0123456789abcdef
api_endpoint: https://api.github.com

Uncomment api_token and set to a Personal Access Token to enable the Search functionality. Any valid access token (with no scopes/privileges enabled) will do.

See: https://github.com/settings/tokens