Jekyll Blog Development Guidelines

Jekyll Blog Development Guidelines

Build Commands

  • bundle install - Install dependencies
  • bundle exec jekyll serve - Run local development server
  • bundle exec jekyll build - Build site for production
  • bundle exec jekyll serve --livereload - Run with auto-reload

Style Guidelines

  • Front Matter: Include layout, title, description, date, author, image, tags
  • Naming: Use kebab-case for filenames (YYYY-MM-DD-post-title.md)
  • Images: Store in /images/ directory, use site.baseurl in paths
  • Formatting: Use Markdown for content, respect SASS indentation (2 spaces)
  • Collections: Follow established patterns for posts, pages, authors
  • Liquid Tags: Use consistent syntax for includes and variable references
  • SASS: Follow the established directory structure and component organization

Content Structure

  • Use headers (## for H2, ### for H3) to organize content
  • Include featured image for all posts
  • Use quote blocks, image captions, and special notes where appropriate