Skip to content

mat-0/TheChels.uk

Repository files navigation

Site

A blog hosted on GitHub available at TheChels.uk. The site uses Jekyll, a static site generator, on Ruby. DNS and SSL by Cloudflare. It also uses GitHub actions, GitHub issues, and Python for extensive automation.

It is called "weak notes" as play on words of the popular "week notes" blogging style - due to the likelihood I will be inconsistent and non-regular.

Badges

Quality Control

Run tests CodeQL Lighthouse Link Checker Linter Clear Cache Pages

Content Management

Add Book Add Now and Next Add Offers Add Post Add Podcast Add Quotes Add Stock

Morning

In order for the page to work you need to enter some secrets for the repository. There are also a bunch of config files (json) that need updating to suit your needs.

  1. An open weather API key - you can register for a free account on their website.
  2. Latitude and Longitude for the weather API.
  3. Update stocks.json with the ticker ids for the stocks you want prices for.
  4. Update comps.json with the list of competition slugs used by the BBC in order to get the relevant football fixtures
  5. Update quotes.json with your favourite quotes.

Configuration

There are a number of optional settings for you to configure. Use the example _config.yml file in the repo and use the documentation below to configure your site:

Config

Using includes

There are 2 main includes: one for the header and one for the footer, largely to minimise repetititon.

Using layouts

Layouts exist on an almost one-to-one relationship with pages, handling any page specifics, post.html is the layout used for every blog post. There also default templates and an empty template used for scss and other special pages such as humans.txt

Using Data

Many aspects of the site are powered by data files and these are updating via issues and GitHub Actions, including most of the content on the Morning page.

Site navigation

Using configuration yml, navigation is provided by three collections for header, footer, and around_the_web (on the about page) and are fairly self-explanatory.