Aviary

A clean, Apple-style Jekyll theme for GitHub project pages with stunning design, text gradients, and dark mode support. I use it for my Swift Packages.

Features

• Modern, Apple-inspired design
• Dark mode support
• Beautiful text gradients
• Mobile responsive
• Automatic GitHub repository information
• Zero configuration needed for GitHub Pages

Installation

To use this theme with GitHub Pages:

1. I make no promises about supporting any other website beyond my own. If you want to use this, start by forking it.

2. Add the following to your site's _config.yml:

remote_theme: username/aviary

Replace username with your GitHub username.

2. That's it! The theme automatically uses your:

   • Repository name as the title
   • Repository description as the subtitle
   • Repository URL for the GitHub button
   • Owner name in the footer copyright

3. Optionally, add documentation link:

# Only needed if you want to add a documentation button
documentation_url: "https://example.com/docs"

# Optional: override the copyright name in the footer
copyright_owner: "Your Full Name"

Customization

The theme uses GitHub metadata by default, but you can override with your own settings:

title: "Custom Title"           # Override repository name
description: "Custom description" # Override repository description
copyright_owner: "Your Legal Name" # Override name in copyright footer

License

This theme is available as open source under the MIT License.