Skip to content

About

thechels.uk - The official thechelsuk website, built using Jekyll, Python, and GitHub Actions. Hosted on GitHub Pages.

Resources

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

1 watching

Forks

Latest commit

 

History

7,294 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Site

A blog hosted on GitHub is 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 a play on words of the popular "week notes" blogging style - due to the likelihood, I will have an inconsistent and irregular cadence for posting.

Badges

Quality Control

Run tests CodeQL Lighthouse Link Checker Linter Clear Cache Pages

Content Management

Add Book Add Film Add Offers Add Post Add Podcast Add Quotes Add Stock

Configuration

There are several 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 repetition.

Using layouts

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

Using Data

Data files power many aspects of the site and these are updated via issues and GitHub Actions.

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.

Post Types

Postings

Mixtape Monthly Guide

  • Monthly, create a mixtape running the shortcut
  • Open the produced and resize to 832px width
  • Copy the image to theimage/mixtapes/ folder ensuring the name matches the format yyyy-MM.png
  • Push a commit to Prod

Add a Film

  • In Drafts, Click the film template, run the Search Film action pick film.
  • Add a rating using the placeholder and run the Add Film action.

Add a Book

  • Run a workflow dispatch - entering the ISBN
  • Download the cover image
  • Resize to a height of 183px
  • Save the cover image into the images/books folder ensuring the name matches the format book-[isbn].png
  • Push a commit to Prod

Quote posts

  • Capture the selection on a page in safari
  • Share to Drafts and click Save
  • In Drafts run the Super Post Maker and choose the Quote post type.
  • Commit the change in WorkingCopy App and push to Prod

Supported Post Types

The following post_type variants are supported:

  • mixtape
  • til
  • ways
  • video
  • release
  • rss
  • daily
  • linked
  • quote
  • film
  • micro
  • blog
  • test
  • gift
  • mailbox

Any other value will use a default icon.

Create a blog post in Drafts and run the Super Post Maker action to select the post type and generate the correct front matter for the post. The post will be created in the _posts folder with a filename of yyyy-MM-dd-title.md.

Additional Front Matter

  • Choose 'Indie' to post to the IndieWeb feed
  • Choose 'Pinned' to pin this post to the top of the post type archive page

How to Run the Site Locally

Local Development
  • Clone the repository:

    git clone https://github.com/thechelsuk/uk.thechels.git
  • Navigate into the project directory:

    cd uk.thechels
  • Install the required dependencies:

    bundle install
  • Build and serve the site locally:

    bash run.sh
  • Open your browser and go to http://localhost:4000 to see your site.

    http://localhost:4000

Cloudflare CSP Rules

Content-Security-Policy Add the following Content-Security-Policy (CSP) rules to your Cloudflare settings to enhance the security of your site:
 default-src 'self'; img-src 'self' https:; script-src 'self' <https://static.cloudflareinsights.com> 'unsafe-inline'; connect-src 'self' <https://cloudflareinsights.com>; style-src 'self' 'unsafe-inline'; font-src 'self'; manifest-src 'self';

About

thechels.uk - The official thechelsuk website, built using Jekyll, Python, and GitHub Actions. Hosted on GitHub Pages.

Resources

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages