https://github.com/regulad/crust-tastic

A lightweight & versatile Jekyll theme built for Github-Pages
https://github.com/regulad/crust-tastic

github github-pages gtag jekyll jekyll-site jekyll-theme jekyll-website site website

Last synced: 16 days ago
JSON representation

A lightweight & versatile Jekyll theme built for Github-Pages

• Host: GitHub
• URL: https://github.com/regulad/crust-tastic
• Owner: regulad
• License: gpl-3.0
• Created: 2021-01-24T22:09:55.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-11-10T21:13:40.000Z (about 3 years ago)
• Last Synced: 2024-11-14T22:37:10.575Z (3 months ago)
• Topics: github, github-pages, gtag, jekyll, jekyll-site, jekyll-theme, jekyll-website, site, website
• Language: HTML
• Homepage: https://www.regulad.xyz/crust-tastic/
• Size: 166 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Crust-Tastic Jekyll Theme

A lightweight & versatile Jekyll theme designed for GitHub-Pages

## Features

* Configurable & Customizable

* Nothing enabled by default

* Fully open source with a strict license (GNU GENERAL PUBLIC LICENSE)

* Compatible with GitHub-Pages

* No need to install any Gems (Besides `github-pages`)

* Easy to get started with

* Lightweight

* Compatible with all browsers (designed to Mozilla spec)

## Setup

Want to use this theme?

Add these lines to your `_config.yml`, or update them if they are already present.

```yaml

remote_theme: regulad/crust-tastic@main # You can also use the latest tag.

plugins:

  - github-pages

```

Make sure your `Gemfile` is set up correctly, too.

```ruby

source 'https://rubygems.org'

group :jekyll_plugins do

  gem "github-pages"

end

```

## Customization & Configuration

`crust-tastic` was designed with modularity and customization in mind.

### `_config.yml` options

Nothing is turned on by default, so you will want to turn on some things.

Some sensible settings can be seen in `_config.yml`.

```yaml

crust_tastic:

  github: truthy/falsey # Controls the GitHub info displayed at the top and the bottom of the page.

  gtag: G-YOURTAGHERE # Controls site gtag.  

  gads: ca-pub-1010101010101010 # Controls site google ads

  favicon: truthy/falsey # Controls the favicon of the webpage. If you would like to use a custom path, substitute truthy/falsey with /path/to/favicon, otherwise it will use the root of the site.

  header_menu:

    google_search: 96969696969696969 # Controls Google Programmable Search. Enter your CX value.

    navigation: false # See below.

```

#### Navigation

* `navigation: truthy/falsey, or "subfolder"` Controls the navigation in the footer. See [my demo website](https://regulad.xyz/crust-tastic/) for a full example. Subfolder enables subfolders.

Subfolder Example:

```yaml

list_title: Navigation

entries:

  - title: Pages

    subfolderitems:

      - page: Home

        url: /

```