# Insights4YOU Jekyll Theme A sleek and modern Jekyll theme inspired by the [Tabler Admin Dashboard](https://github.com/tabler/tabler). This theme offers a clean, professional, and responsive interface, making it ideal for developers, content creators, and businesses. Whether you're building documentation sites, admin panels, or project showcases, this theme provides a minimal-effort solution with customizable layouts and modern design elements. ![Theme Preview](assets/images/preview-dark.png) [![last commit](https://img.shields.io/github/last-commit/marciopaiva/insights4you-jekyll-theme?logo=github)][repo] [![gem build](https://github.com/marciopaiva/insights4you-jekyll-theme/actions/workflows/gem-build.yml/badge.svg)][build] [![codacy badge](https://img.shields.io/codacy/grade/4e556876a3c54d5e8f2d2857c4f43894?logo=codacy)][codacy] [![gem version](https://img.shields.io/gem/v/insights4you-jekyll-theme?&logo=rubygems&logoColor=ghostwhite&label=gem&color=orange)][gem] [![downloads](https://img.shields.io/gem/dt/insights4you-jekyll-theme?logo=rubygems&color=blue)][gem] [![github license](https://img.shields.io/github/license/marciopaiva/insights4you-jekyll-theme?color=goldenrod)][license]

🌟 Features

  • 🌙 Dark and Light Themes: Switch between dark and light modes for a personalized experience
  • 📱 Responsive Design: Fully optimized for mobile, tablet, and desktop devices
  • 🔧 Customizable Layouts: Easily modify layouts to suit your needs
  • 🚀 SEO Optimized: Built-in support for Jekyll SEO tags to improve search engine visibility
  • 📦 Gem-Based Installation: Simple installation via RubyGems
  • 📝 Markdown Support: Write content using Markdown for simplicity and flexibility
  • 🎨 Modern Design: Inspired by the Tabler Admin Dashboard for a sleek and professional look
  • 📊 Analytics Ready: Add analytics scripts easily for tracking user interactions
  • 🔍 Search Functionality: Built-in search capabilities for content discovery
  • 🎯 Clean Code: Well-documented and maintainable codebase
  • 🛠️ Developer Friendly: Easy to extend and customize
  • 📱 Mobile First: Designed with mobile devices in mind

📋 Requirements

  • Ruby >= 2.7.0
  • Jekyll ~> 4.2
  • Bundler ~> 2.3

🚀 Quick Start

  1. Install the theme:

    gem install insights4you-jekyll-theme

  2. Create a new Jekyll site:

    jekyll new my-website

  3. Add the theme to your Jekyll site's Gemfile:

    gem "insights4you-jekyll-theme"

  4. Update your _config.yml:

    theme: insights4you-jekyll-theme

  5. Install dependencies:

    bundle install

  6. Start your site:

    bundle exec jekyll serve

🎯 Demo Site

To see the theme in action, check out the included example site:

# Clone the repository
git clone https://github.com/marciopaiva/insights4you-jekyll-theme.git

# Navigate to theme directory
cd insights4you-jekyll-theme

# build and test
make dev

Visit http://localhost:4000 to see the demo site in action.

🎨 Customization

Theme Configuration

[WIP]

Available Layouts

  • default: Standard page layout

Custom Styling

Create a new file assets/css/custom.scss to add your own styles:

[WIP]

📝 Documentation

Directory Structure

[WIP]

Creating Posts

[WIP]

Creating Pages

[WIP]

🤝 Contributing

We love your input! We want to make contributing to Insights4YOU as easy and transparent as possible. Please:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Tabler Admin Dashboard for design inspiration
  • Jekyll community for the amazing static site generator
  • All contributors who help improve this theme