al-minimal

al-minimal

A modern, minimal personal blog built with Jekyll and Tailwind CSS. Perfect for developers who want a clean blog on GitHub Pages.

šŸ“ Minimal Jekyll Blog

A modern, minimal personal blog built with Jekyll and Tailwind CSS. Perfect for developers who want a clean, professional blog on GitHub Pages.

🌟 Features

  • Responsive Design - Beautiful dark theme, mobile-first approach
  • Blog Posts - Markdown posts with pagination (10 per page)
  • Projects Portfolio - Showcase your work
  • Tags System - Organize posts by tags
  • Table of Contents - Auto-generated TOC for long posts
  • Social Sharing - Twitter, LinkedIn, Facebook, Reddit, Telegram
  • SEO Optimized - Sitemap, meta tags, RSS feed
  • Clean URLs - No .html extensions
  • GitHub Actions - Automated deployment
  • Fast & Lightweight - Optimized performance

šŸš€ Getting Started

Quick Start

  1. Click "Use this template" button at the top of this repository
  2. Create a new repository from the template
    • Name it yourusername.github.io (replace with your GitHub username)
    • Choose public
    • Click "Create repository"
  3. Wait a few seconds for GitHub Actions to build your site

That's it! šŸŽ‰ Your blog is now live at https://yourusername.github.io

Local Development & Customization

Want to customize your blog or run it locally?

  1. Clone your repository:
git clone https://github.com/yourusername/yourusername.github.io.git
cd yourusername.github.io
  1. Install dependencies:
bundle install
npm install
  1. Build CSS:
npm run build:css
  1. Run locally:
bundle exec jekyll serve

Visit http://localhost:4000 to preview changes locally.

For detailed installation and setup: See INSTALL.md

šŸ“š Documentation

⚔ Quick Customization

Edit _config.yml:

# -----------------------------------------------------------------------------
# Site settings
# -----------------------------------------------------------------------------

title: Your Name
first_name: Your
last_name: Name
greeting: "Hi, I'm Your Name!"
email: [email protected]
url: "https://yourusername.github.io"
icon: āš›ļø  # emoji used as favicon

# Social Media
social:
  - icon: fa-brands fa-github
    link: https://github.com/yourusername
    name: GitHub
  # Add more...

Configuration is organized into clear sections with comments. For more: See CUSTOMIZING.md

šŸ“ Writing Your First Post

Create _posts/2025-01-15-my-first-post.markdown:

---
layout: post
title: "My First Post"
date: 2025-01-15 10:00:00 +0000
tags: [tutorial, getting-started]
excerpt: "A brief description"
---

Your content here...

For more details: See CONTENT.md

🚢 Deploy to GitHub Pages

  1. Push to GitHub
  2. Go to Settings → Pages
  3. Select GitHub Actions as source
  4. Done! Your site is live at https://yourusername.github.io

For detailed deployment: See DEPLOYMENT.md

šŸ“‚ Project Structure

.
ā”œā”€ā”€ _includes/          # Reusable components
ā”œā”€ā”€ _layouts/           # Page templates
ā”œā”€ā”€ _posts/             # Your blog posts
ā”œā”€ā”€ _projects/          # Your projects
ā”œā”€ā”€ assets/             # CSS, images
ā”œā”€ā”€ docs/               # Documentation
ā”œā”€ā”€ _config.yml         # Configuration
└── README.md           # This file

šŸ™ Acknowledgments

Powered by these amazing tools:

šŸ¤ Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

šŸ“„ License

MIT License - See LICENSE for details.


Made with ā¤ļø for developers

⭐ Star this repo if you find it useful!

šŸ“ Fork it to create your own blog!

šŸ“¢ Share it with others!