A work-in-progress Jekyll theme for City websites on GitHub Pages.
HTML Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_example
_includes
_layouts
assets/vendor/uswds-0.12.1
.gitignore
.ruby-version
Gemfile
README.md
_config.yml
about.md
compositor.json
example.md
index.md
jekyll-theme-zilker.gemspec

README.md

🚧 WIP 🚧 Zilker Jekyll Theme

Zilker is a work-in-progress Jekyll theme for City of Austin websites.

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-zilker", github: "cityofaustin/zilker-theme"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-theme-zilker

And then execute:

$ bundle

Usage

Navigation

Zilker generates site-wide navigation automatically, with zero configuration. The primary "global" navigation renders Jekyll's site.pages sorted by URL and optionally by a position front-matter property, if set.

Pages in subfolders, like parent/child.md, render as visual children of their parent, e.g. parent.md. The parent page must exist for the child page to appear in the navigation.

The navigation logic is recursive, and works with deeply nested children, but exceeding two levels is not recommended.

Collections

Zilker also supports per-section sub-navigation using Jekyll Collections. Given a collection named example, each document in _example/ will include navigation to the other documents in the collection when output.

To show a collection in the primary navigation, Zilker looks for a "collection index" page at the site root, e.g. example.md. The page's front-matter must include a collection property matching the collection key in _config.yml, and its permalink must match the collection's.

Sorting and parent-child relationships work the same way in a collection's sub-navigation as in the primary navigation.

Configuration

TBD

Components

TBD

Layouts

TBD