Skip to content

CLAUDE.md

Latest commit

 

History

History
146 lines (113 loc) · 4.41 KB

CLAUDE.md

File metadata and controls

146 lines (113 loc) · 4.41 KB

CLAUDE.md

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

Project Overview

This is a Hugo static site generator project for a Russian-language technology blog called "Coding Overhead" (coding-overhead.ru). The site covers topics related to GNU/Linux, DevOps, Platform Engineering, programming, and useful utilities.

Key Commands

Building and Development

# Build the static site
hugo

# Start development server with live reload and drafts
hugo server -D --bind 0.0.0.0

# Start development server without drafts
hugo server

# Build for production (outputs to public/)
hugo --minify

# Clean generated resources and public directory
rm -rf public/ resources/_gen/

Deployment

# Deploy to AWS S3 (requires AWS CLI configuration)
hugo deploy --target production

# Build and deploy in one command
hugo --minify && hugo deploy --target production

The site is configured to deploy to AWS S3 (s3://coding-overhead.ru) as specified in hugo.yaml deployment configuration.

Content Management

# Create new post
hugo new posts/[post-name]/index.md

# Create new post with Org mode (alternative format used in this blog)
hugo new posts/[post-name]/index.org

Site Architecture

Theme Structure

  • Uses custom theme vng-blue located in themes/vng-blue/
  • Theme supports responsive design with configurable home page layouts
  • Includes social media integration and custom styling

Content Organization

  • Content: All content in content/ directory
  • Posts: Blog posts in content/posts/ with subdirectories per post
  • Pages: Static pages like About in content/about.md
  • Assets: Images and media files in assets/ and static/

Supported Content Formats

  • Markdown: Standard .md files with Hugo front matter
  • Org Mode: .org files (Emacs Org mode format) - used for some posts
  • Mixed format support allows flexible content creation

Configuration

  • Main config: hugo.yaml (YAML format)
  • Theme configuration includes:
    • Social media links (GitHub, LinkedIn, YouTube, Twitch)
    • Custom analytics (Yandex.Metrika)
    • Home page event positioning
    • Multilingual support (Russian)

Key Features

  • Categories and Tags: Organized content taxonomy
  • Custom Home Page: Configurable event sections and logos
  • Social Integration: Links to various social platforms
  • Analytics: Yandex.Metrika tracking
  • Responsive Design: Mobile-friendly layout
  • HiDPI Support: High-resolution image handling

Content Creation Guidelines

Front Matter Structure

Standard Markdown posts use YAML front matter:

---
title: "Post Title"
summary: "Brief description"
categories:
  - "Category Name"
tags:
  - tag1
  - tag2
date: 2024-01-01T12:00:00
draft: false
---

Org mode posts (.org files) use the same YAML front matter format at the beginning of the file.

Image Handling

  • Place images in post directories alongside content
  • Theme supports HiDPI displays - provide double resolution images
  • Home page images: home-logo-top.png (1600x530), home-logo-bottom.png (2080x470)
  • Sidebar logo: minimum 440x440px

Categories and Tags

  • Categories used for major topic groupings (e.g., "Настройка окружения Hyprland от начала до конца")
  • Tags for specific technologies (linux, hyprland, etc.)
  • All content in Russian language

Theme Customization

The vng-blue theme can be customized through:

  • hugo.yaml parameters section
  • Custom CSS in theme assets
  • Logo replacements in assets/ directory
  • Social media configuration in params.social

Development Notes

  • Generated files in public/ directory (ignored in git)
  • Resources cache in resources/_gen/ (can be cleared if needed)
  • Theme is included as git submodule at themes/vng-blue/
  • No package.json or Node.js dependencies - pure Hugo project
  • Site uses Russian language and content
  • Yandex.Metrika analytics configured in hugo.yaml

Git Submodule Management

The theme is managed as a git submodule:

# Update theme submodule
git submodule update --remote themes/vng-blue

# Initialize submodules (if cloning fresh repo)
git submodule update --init --recursive

Org Mode Support

  • Org mode files (.org) are supported alongside Markdown
  • Use Emacs Org mode syntax for content structure
  • Internal links use [[denote:ID][description]] format
  • Code blocks use #+begin_src and #+end_src