CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Data Platform Design — a Jekyll static blog at dataplatformdesign.com focused on data platform architecture, engineering, and best practices.

Tech Stack

  • Framework: Jekyll (static site generator)
  • Theme: Custom — purple palette, Inter + Merriweather fonts, light/dark toggle. Remote theme mmistakes/minimal-mistakes is kept for pagination/SEO plugin support but all layouts and styles are fully overridden in _layouts/, _includes/, and assets/.
  • Hosting: GitHub Pages (github-pages gem)

Layouts

Layout Used for
single Blog posts (Medium-like reading view)
home Homepage with post card grid
page Static pages (About, etc.)
categories Category archive
tags Tag archive
default Base HTML shell (wrapped by all other layouts)

Key Files

  • assets/css/style.css — all custom CSS (purple palette, light/dark CSS variables)
  • assets/js/theme-toggle.js — light/dark mode toggle + mobile nav
  • assets/images/favicon.svg — site favicon (also used as inline logo icon)

Common Commands

# Serve locally
bundle exec jekyll serve

# Build
bundle exec jekyll build

# Install dependencies
bundle install

Note: _config.yml changes require restarting the server — they are not hot-reloaded.

Blog Post Conventions

  • Files in _posts/ follow the naming pattern: YYYY-MM-DD-slug.md
  • All posts use layout: single — this is the custom Medium-like reading layout
  • Required front matter fields: layout, title, date, author: Peter, categories
  • Content covers data platform topics: medallion architecture, CI/CD, platform engineering, code control

Front matter template

---
layout: single
title: "Post Title"
date: YYYY-MM-DD HH:MM:SS +0000
author: Peter
categories: [category1, category2]
tags: [tag1, tag2]
excerpt: "One sentence description shown on the homepage card."
toc: true
---