CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
Project Overview
This is a Jekyll-based static site for SunnyBox (email API service) deployed on GitHub Pages. The site uses a custom implementation of Tachyons CSS framework with dark mode support.
Common Commands
Setup
bundle install
Development Server
bundle exec jekyll serve --livereload
Deployment
Push to the main
branch - GitHub Pages automatically deploys changes.
Architecture
Jekyll Structure
- Layouts: Located in
_layouts/
- default, blog, docs, and plain templates - Blog Posts: Follow Jekyll naming convention in
_posts/
(YYYY-MM-DD-title.md) - Data Files:
_data/changelog.yml
for structured changelog data - Static Pages: Markdown files in root (index.md, pricing.md, docs.md, etc.)
Styling System
- Framework: Custom Tachyons implementation in
_sass/tachyons.scss
- Dark Mode: Uses
dm-
prefixed classes for dark mode variants - Entry Point:
/assets/css/main.scss
imports all SCSS modules - Responsive: Tachyons breakpoint suffixes (-ns, -m, -l for responsive design)
Key Features
- Animations: WOW.js in
/assets/js/wow.js
for scroll-triggered animations - SEO: Jekyll plugins for sitemap and RSS feed generation
- Performance: WebP images, optimized assets
- Custom Domain: Configured via CNAME file (sunnybox.io)
Configuration
Main Jekyll configuration in _config.yml
:
- URL: https://sunnybox.io
- Plugins: jekyll-feed, jekyll-sitemap
- Syntax highlighting: Rouge
- Excludes Sublime project files