rishi raj's blog

Sobolev2 Jekyll Theme - Summary

What’s Included

This theme package contains everything needed to create a modern, minimalist Jekyll website with both standalone and gem distribution options.

Directory Structure

sobolev2-jekyll-theme/
├── README.md                    # Main documentation
├── INSTALLATION.md              # Step-by-step installation guide
├── CUSTOMIZATION.md             # Detailed customization guide
├── CREDITS.md                   # Attribution and licenses
├── LICENSE                      # MIT License
├── .gitignore                   # Git ignore file
├── THEME_SUMMARY.md            # This file
├── standalone/                  # Standalone version
│   ├── _layouts/               # Jekyll layouts (6 files)
│   ├── _includes/              # Reusable components (8 files)
│   ├── _sass/                  # SCSS stylesheets (14 files)
│   ├── css/                    # Main SCSS file
│   ├── assets/                 # Fonts, images, favicons
│   ├── _posts/                 # Sample blog posts (3 files)
│   ├── _talks/                 # Sample talks (2 files)
│   ├── _activities/            # Sample activities (2 files)
│   ├── _pages/                 # Sample pages
│   ├── _config.yml             # Jekyll configuration
│   ├── Gemfile                 # Ruby dependencies
│   ├── index.html              # Homepage
│   └── .gitignore              # Git ignore for standalone
└── gem/                        # Ruby gem version
    ├── sobolev2-jekyll-theme.gemspec  # Gem specification
    ├── lib/
    │   ├── sobolev2-jekyll-theme.rb   # Theme loader
    │   └── sobolev2-jekyll-theme/     # Theme files
    │       ├── _layouts/              # Same as standalone
    │       ├── _includes/             # Same as standalone
    │       ├── _sass/                 # Same as standalone
    │       ├── css/                   # Same as standalone
    │       └── assets/                # Same as standalone

Features Included

🎨 Design Features

  • Modern, minimalist aesthetic
  • Light/dark mode with automatic switching
  • Card-based layouts for content
  • Responsive design for all devices
  • Beautiful typography with Source Sans 3 and Roboto Mono

⚡ Performance Features

  • Optimized for Core Web Vitals (LCP, FID, CLS)
  • Efficient font loading with fallbacks
  • Optimized images and assets
  • Minimal JavaScript usage
  • Fast build times

🛠 Technical Features

  • SEO optimized with sitemap and feeds
  • WCAG compliant accessibility
  • Collections support (talks, activities)
  • Flexible layout system
  • Easy customization through CSS variables

📝 Content Features

  • Blog posts with rich front matter
  • Talks/events with metadata
  • Activities/projects showcase
  • About page template
  • Archive pages

Quick Start

For Standalone Version:

  1. Copy the standalone/ folder contents
  2. Run bundle install
  3. Edit _config.yml with your information
  4. Run bundle exec jekyll serve

For Gem Version:

  1. Add gem "sobolev2-jekyll-theme" to your Gemfile
  2. Set theme: sobolev2-jekyll-theme in _config.yml
  3. Run bundle install

Documentation

  • README.md: Overview, features, and basic usage
  • INSTALLATION.md: Detailed installation instructions
  • CUSTOMIZATION.md: Complete customization guide
  • CREDITS.md: Attribution and license information

Sample Content

The theme includes comprehensive sample content:

  • 3 Blog Posts: Showcasing different content types and front matter
  • 2 Talks: Conference presentations with metadata
  • 2 Activities: Projects and contributions
  • About Page: Professional about page template
  • Homepage: Archive-style blog listing

Customization Options

Easy Customization

  • CSS custom properties for colors and typography
  • Modular SCSS architecture
  • Flexible configuration options
  • Multiple layout templates

Advanced Customization

  • Custom layouts and includes
  • JavaScript enhancements
  • Performance optimizations
  • Accessibility improvements

Browser Support

  • Chrome (latest)
  • Firefox (latest)
  • Safari (latest)
  • Edge (latest)
  • Internet Explorer 11+

License

MIT License - Free for personal and commercial use.

Support

  • GitHub Issues: Bug reports and feature requests
  • GitHub Discussions: Community support
  • Email: r@rishi.im
  • Website: https://rishiraj.blog

Ready to build your modern Jekyll site? Choose your preferred installation method and get started!