πŸš€ Complete Setup Guide for Your Jekyll Blog

Your minimalist Jekyll blog is now ready! Follow this guide to get it running on GitHub Pages.

πŸ“‹ What’s Been Set Up

βœ… Minimalist Theme: β€œno-style-please” theme for clean, fast loading
βœ… Chronological Posts: Homepage displays posts in reverse chronological order
βœ… Tagging System: Full tagging functionality with dedicated tags page
βœ… Comments Ready: Giscus integration for GitHub Discussions-based comments
βœ… GitHub Pages Compatible: Configured for seamless GitHub Pages deployment
βœ… Sample Content: 4 sample blog posts with various tags
βœ… Responsive Design: Works perfectly on all devices

πŸ› οΈ Immediate Setup Steps

1. Update Personal Information

Edit _config.yml and update these fields:

title: Your Name
email: your-email@example.com
description: Your blog description
github_username: your-github-username
twitter_username: your-twitter-handle  # optional

2. Update About Page

Edit about.markdown and replace placeholder information with your details:

  • GitHub username
  • Email address
  • Twitter handle
  • Personal bio and interests

3. GitHub Repository Setup

  1. Create a new GitHub repository (or use existing one)
  2. Push your code:
    git add .
    git commit -m "Initial blog setup"
    git push origin main
    

4. Enable GitHub Pages

  1. Go to your repository on GitHub
  2. Click Settings β†’ Pages
  3. Under β€œSource”, select β€œDeploy from a branch”
  4. Choose β€œmain” branch
  5. Click Save

Your blog will be available at: https://your-username.github.io/your-repo-name

  1. Enable Discussions in your GitHub repository:
    • Go to Settings β†’ General
    • Scroll to β€œFeatures” section
    • Check β€œDiscussions”
  2. Configure Giscus:
    • Visit giscus.app
    • Enter your repository details
    • Copy the generated configuration
    • Update _config.yml:
    giscus:
      repo: "your-username/your-repo-name"
      repo_id: "R_kgDOxxxxxxx"  # from giscus.app
      category: "General"
      category_id: "DIC_kwDOxxxxxxx"  # from giscus.app
    

πŸ“ Writing Your First Post

  1. Create a new file in _posts/ with format: YYYY-MM-DD-title.md

  2. Add front matter:
    ---
    layout: post
    title: "Your Post Title"
    date: 2025-01-30 10:00:00 +0530
    tags: [tag1, tag2, tag3]
    ---
       
    Your post content here...
    
  3. Write in Markdown - Jekyll supports full Markdown syntax

🎨 Customization Options

Adding New Pages

  • Create .md files in root directory
  • Add to navigation by updating header_pages in _config.yml

Styling

  • Override theme styles in _sass/ directory
  • Add custom CSS to layout files
  • Modify existing layouts in _layouts/

Features

  • Dark Mode: Automatic based on system preference
  • Fast Loading: Minimal CSS and optimized assets
  • SEO Friendly: Proper meta tags and structured data
  • RSS Feed: Automatic feed generation at /feed.xml

πŸ”§ Local Development

Prerequisites

  • Ruby (2.7 or higher)
  • Bundler gem

Setup

# Install dependencies
bundle install

# Start local server
bundle exec jekyll serve

# Visit your blog
open http://localhost:4000

Development Tips

  • Changes auto-reload (except _config.yml)
  • Drafts go in _drafts/ folder
  • Use --drafts flag to preview drafts locally

πŸ“ File Structure Overview

β”œβ”€β”€ _config.yml              # Main configuration
β”œβ”€β”€ _posts/                  # Blog posts
β”‚   β”œβ”€β”€ 2025-01-15-my-coding-journey.md
β”‚   β”œβ”€β”€ 2025-01-20-setting-up-development-environment.md
β”‚   β”œβ”€β”€ 2025-01-25-understanding-git-basics.md
β”‚   └── 2025-05-31-welcome-to-jekyll.markdown
β”œβ”€β”€ _layouts/                # Custom layouts
β”‚   β”œβ”€β”€ home.html           # Homepage layout
β”‚   └── post.html           # Blog post layout
β”œβ”€β”€ _includes/               # Reusable components
β”‚   └── giscus_comments.html # Comments component
β”œβ”€β”€ .github/workflows/       # GitHub Actions
β”‚   └── jekyll.yml          # Auto-deployment
β”œβ”€β”€ tags.md                  # Tags page
β”œβ”€β”€ about.markdown           # About page
β”œβ”€β”€ index.markdown           # Homepage
β”œβ”€β”€ Gemfile                  # Ruby dependencies
└── README.md               # Documentation

πŸš€ Deployment

Automatic Deployment

  • GitHub Actions workflow is configured
  • Pushes to main branch trigger automatic deployment
  • No manual intervention required

Manual Deployment

If you prefer manual deployment:

  1. Disable GitHub Actions workflow
  2. Use GitHub Pages source: β€œDeploy from a branch”
  3. Push to main branch

🎯 Next Steps

  1. Write your first post - Replace sample posts with your content
  2. Customize the about page - Make it personal
  3. Set up comments - Enable community engagement
  4. Share your blog - Start building your audience
  5. Regular posting - Consistency is key to growing readership

πŸ†˜ Troubleshooting

Common Issues

Blog not loading on GitHub Pages:

  • Check repository settings β†’ Pages
  • Ensure main branch is selected
  • Wait 5-10 minutes for deployment

Comments not working:

  • Verify Discussions are enabled
  • Double-check Giscus configuration
  • Ensure repository is public

Local development issues:

  • Run bundle install after any Gemfile changes
  • Restart server after _config.yml changes
  • Check Ruby version compatibility

Getting Help

πŸ“ˆ Growing Your Blog

Content Strategy

  • Write consistently (weekly/bi-weekly)
  • Focus on your expertise areas
  • Engage with your audience through comments
  • Share posts on social media

SEO Tips

  • Use descriptive titles
  • Add relevant tags
  • Write meta descriptions
  • Include internal links

Community Building

  • Respond to comments promptly
  • Engage with other developers’ blogs
  • Share valuable, actionable content
  • Be authentic and personal

Congratulations! πŸŽ‰ Your minimalist blog is ready to go. Start writing and sharing your knowledge with the world!

Need help? Feel free to open an issue in your repository or reach out to the community.