insights4you-jekyll-theme 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b1fb0a09c09bea65e66d227a87d457a2c07a1992ecf990704baa0f2b3a72cc4
-  data.tar.gz: d837a99c62fcfe008bea93d44cac410ddad97c901980f5a6503c257e1a4ab48c
+  metadata.gz: 7e7de0952caad7e7ba6bdb9650aaa40e8a343c177967a0cdbf42801a46f1d738
+  data.tar.gz: 727f114144cd5246336b73239b9cc285d8240cd7bbf68b6ec42479185040096f
 SHA512:
-  metadata.gz: 5d97e2a13ac71bc6bf9e2e3a63e17c2981cd52e2651ace5a17fc509c75e7765b81fac3478126ff7605f7111fe92ed2eca194b085b0e961b9c76b69b6204e616e
-  data.tar.gz: f3e86d977c3b267eb161580660c0eed529c95a4a849b16f8028adb09171ac35900979a2b7377f8c3cf75691c8f0722ee2601477f73bc2119bc305ed5526ad2cd
+  metadata.gz: 804f08bc79666cc67596b3bf0ab5cafcf61a6279f18e10c4852c1fadd4f57ef6e6b501f0cea1154c421e9251bc2a9c856699f1992f5493ee2bf6269e16e09478
+  data.tar.gz: c00d4da9f2ac0caf0fa15acc27426a0d8e5f9065d35223a62238eae69c614afb35db0bc6f507817ed559e7566513f12bbb9eb052344f59b245f64d270fa1a242

data/CHANGELOG.md

@@ -0,0 +1,110 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.4.0]
+
+### Added
+- **New UI Components**: Introduced additional UI components in the `_includes/ui` directory.
+- **Custom JavaScript**: Added `assets/js/custom.js` for custom JavaScript functionalities.
+- **Enhanced Documentation**: Updated `README.md` with detailed instructions and feature descriptions.
+- **Gem Metadata**: Enhanced gemspec metadata with additional documentation and support links.
+
+### Changed
+- **Theme Configuration**: Updated `_config.yml` in the example site for better theme configuration.
+- **Dependencies**: Updated runtime and development dependencies in `insights4you-jekyll-theme.gemspec`.
+- **Build Process**: Improved the Makefile for better build and test processes.
+
+### Fixed
+- **Bug Fixes**: Resolved minor bugs and improved overall stability.
+
+### Removed
+- **Deprecated Files**: Removed any deprecated or unused files to clean up the project structure.
+
+## [0.3.0]
+
+### Added
+- **Theme System**: Implemented dark/light theme switching functionality
+- **Theme Toggle**: Added theme toggle buttons in header navigation
+- **Theme Persistence**: Added localStorage support for saving theme preferences
+- **System Theme**: Added automatic system theme preference detection
+- **Accessibility**: Added ARIA attributes and screen reader announcements for theme changes
+- **Sass Architecture**: Added new _sass directory for better style organization
+
+### Changed
+- **Asset Structure**: Reorganized CSS into Sass-based architecture
+- **Resource Loading**: Updated stylesheet and script loading in head.html
+- **Dependencies**: Updated Tabler Core CSS implementation
+- **Example Site**: Updated example pages with new theme support
+- **Documentation**: Enhanced configuration documentation
+- **Build Process**: Improved asset compilation and organization
+
+### Removed
+- **Legacy CSS**: Removed deprecated theme.min.css in favor of Sass structure
+
+### Fixed
+- **Resource Loading**: Fixed stylesheet loading order and dependencies
+- **Theme Toggle**: Improved theme switching reliability
+- **UI Components**: Enhanced component styling for both light and dark themes
+
+
+## [0.2.3]
+
+### Added
+- **Ruby Version Requirement**: Set minimum Ruby version to 3.2.2
+- **Security**: Added `rubygems_mfa_required` metadata flag
+- **Documentation**: Enhanced metadata with additional documentation URIs
+
+### Changed
+- **Dependencies**: Updated Jekyll requirement to >= 4.4.1
+- **Gemspec**: Improved file organization and readability
+- **Installation**: Enhanced post-install message with quick start guide
+
+### Security
+- **Authentication**: Enabled mandatory MFA for RubyGems publishing
+
+
+## [0.2.2]
+
+### Added
+
+- **Social Media Component**: A new component for integrating social media links.
+- **User Profile Component**: A dedicated component for displaying user profile information.
+
+### Changed
+
+- **Notifications**: Resolved issues and improved the functionality of notifications.
+- **Gemspec and Versioning**: Updated the gemspec file and version details for better compatibility.
+- **Dynamic Menu System**: The menu is now dynamically generated, improving flexibility and maintainability.
+- **Component Review**: Conducted a comprehensive review and refinement of all existing components.
+
+### Removed
+
+- **Example Site Test File**: Removed the `example-site/test.html` file as it was no longer needed.
+
+
+## [0.2.0]
+
+### Added
+
+- **UI Components**: Introduced a set of reusable UI components for consistency across the project.
+- **Example Site for Testing**: Implemented an example site to facilitate testing and demonstration of features.
+- **Changelog File**: Created the `changelog.md` file to track project updates systematically.
+
+### Changed
+
+- **Layout Adjustments**: Made improvements to the home, default, and error layouts for better usability and design.
+- **Gemspec Fixes**: Updated the gemspec file to address development-related issues.
+
+### Removed
+
+- **N/A**: No files or features were removed in this release.
+
+
+[0.4.0]: https://github.com/marciopaiva/insights4you-jekyll-theme/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/marciopaiva/insights4you-jekyll-theme/compare/v0.2.3...v0.3.0
+[0.2.3]: https://github.com/marciopaiva/insights4you-jekyll-theme/compare/v0.2.2...v0.2.3
+[0.2.2]: https://github.com/marciopaiva/insights4you-jekyll-theme/compare/v0.2.0...v0.2.2

data/README.md

@@ -1,34 +1,74 @@
-<!-- markdownlint-disable-next-line -->
 <div align='center'>
 
-<!-- markdownlint-disable-next-line -->
 # Insights4YOU Jekyll Theme
 
-A sleek and modern Jekyll theme inspired by the [Tabler Admin Dashboard](https://github.com/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.
+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](https://via.placeholder.com/800x400?text=Insights4You+Theme+Preview)
+![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]
 
-[![last commit](https://img.shields.io/github/last-commit/marciopaiva/insights4you-jekyll-theme?logo=github)][repo]&nbsp;
-[![gem build](https://github.com/marciopaiva/insights4you-jekyll-theme/actions/workflows/gem-build.yml/badge.svg)][build]&nbsp;
-[![codacy badge](https://img.shields.io/codacy/grade/4e556876a3c54d5e8f2d2857c4f43894?logo=codacy)][codacy]&nbsp;
-[![gem version](https://img.shields.io/gem/v/insights4you-jekyll-theme?&logo=rubygems&logocolor=ghostwhite&label=gem&color=orange)][gem]&nbsp;
-[![downloads](https://img.shields.io/gem/dt/insights4you-jekyll-theme?logo=rubygems&color=blue)][gem]&nbsp;
-[![ruby version](https://img.shields.io/badge/ruby-~%3E%203.1-red?logo=ruby)][gem]
-[![github license](https://img.shields.io/github/license/marciopaiva/insights4you-jekyll-theme?color=goldenrod)][license]&nbsp;
 </div>
 
-## Features
+## 🌟 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:**
+```ruby
+gem install insights4you-jekyll-theme
+```
+
+2. **Create a new Jekyll site:**
+```ruby
+jekyll new my-website
+```
+
+3. **Add the theme to your Jekyll site's `Gemfile`:**
+```ruby
+gem "insights4you-jekyll-theme"
+```
+
+4. **Update your `_config.yml`:**
+```yaml
+theme: insights4you-jekyll-theme
+```
 
-- 🌙 **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.
+5. **Install dependencies:**
+```bash
+bundle install
+```
 
-## Example Site
+6. **Start your site:**
+```bash
+bundle exec jekyll serve
+```
+
+## 🎯 Demo Site
 
 To see the theme in action, check out the included example site:
 
@@ -36,19 +76,61 @@ 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 example directory
-cd insights4you-jekyll-theme/example-site
-
-# Install dependencies
-bundle install
+# Navigate to theme directory
+cd insights4you-jekyll-theme
 
-# Serve the site locally
-bundle exec jekyll serve
+# 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
+
+[repo]: https://github.com/marciopaiva/insights4you-jekyll-theme
+[build]: https://github.com/marciopaiva/insights4you-jekyll-theme/actions/workflows/gem-build.yml
+[codacy]: https://app.codacy.com/gh/marciopaiva/insights4you-jekyll-theme/dashboard
 [gem]: https://rubygems.org/gems/insights4you-jekyll-theme
-[codacy]: https://app.codacy.com/gh/marciopaiva/insights4you-jekyll-theme/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
 [license]: https://github.com/marciopaiva/insights4you-jekyll-theme/blob/master/LICENSE
-[build]: https://github.com/marciopaiva/insights4you-jekyll-theme/actions/workflows/gem-build.yml
-[repo]: https://github.com/marciopaiva/insights4you-jekyll-theme
-[issues]: https://github.com/marciopaiva/insights4you-jekyll-theme/issues

data/_data/i4y-colors.json

@@ -0,0 +1,218 @@
+{
+  "base": [
+    {
+      "name": "blue",
+      "variable": "var(--tblr-blue)",
+      "value": "#066fd1"
+    },
+    {
+      "name": "azure",
+      "variable": "var(--tblr-azure)",
+      "value": "#4299e1"
+    },
+    {
+      "name": "indigo",
+      "variable": "var(--tblr-indigo)",
+      "value": "#4263eb"
+    },
+    {
+      "name": "purple",
+      "variable": "var(--tblr-purple)",
+      "value": "#ae3ec9"
+    },
+    {
+      "name": "pink",
+      "variable": "var(--tblr-pink)",
+      "value": "#d6336c"
+    },
+    {
+      "name": "red",
+      "variable": "var(--tblr-red)",
+      "value": "#d63939"
+    },
+    {
+      "name": "orange",
+      "variable": "var(--tblr-orange)",
+      "value": "#f76707"
+    },
+    {
+      "name": "yellow",
+      "variable": "var(--tblr-yellow)",
+      "value": "#f59f00"
+    },
+    {
+      "name": "lime",
+      "variable": "var(--tblr-lime)",
+      "value": "#74b816"
+    },
+    {
+      "name": "green",
+      "variable": "var(--tblr-green)",
+      "value": "#2fb344"
+    },
+    {
+      "name": "teal",
+      "variable": "var(--tblr-teal)",
+      "value": "#0ca678"
+    },
+    {
+      "name": "cyan",
+      "variable": "var(--tblr-cyan)",
+      "value": "#17a2b8"
+    }
+  ],
+  "grays": [
+    {
+      "name": "gray-50",
+      "value": "#f8fafc"
+    },
+    {
+      "name": "gray-100",
+      "value": "#f1f5f9"
+    },
+    {
+      "name": "gray-200",
+      "value": "#e2e8f0"
+    },
+    {
+      "name": "gray-300",
+      "value": "#c8d3e1"
+    },
+    {
+      "name": "gray-400",
+      "value": "#9ba9be"
+    },
+    {
+      "name": "gray-500",
+      "value": "#6c7a91"
+    },
+    {
+      "name": "gray-600",
+      "value": "#49566c"
+    },
+    {
+      "name": "gray-700",
+      "value": "#313c52"
+    },
+    {
+      "name": "gray-800",
+      "value": "#1d273b"
+    },
+    {
+      "name": "gray-900",
+      "value": "#0f172a"
+    }
+  ],
+  "light": [
+    {
+      "name": "blue-lt",
+      "value": "#e9f0f9"
+    },
+    {
+      "name": "azure-lt",
+      "value": "#ecf5fc"
+    },
+    {
+      "name": "indigo-lt",
+      "value": "#eceffd"
+    },
+    {
+      "name": "purple-lt",
+      "value": "#f7ecfa"
+    },
+    {
+      "name": "pink-lt",
+      "value": "#fbebf0"
+    },
+    {
+      "name": "red-lt",
+      "value": "#fbebeb"
+    },
+    {
+      "name": "orange-lt",
+      "value": "#fef0e6"
+    },
+    {
+      "name": "yellow-lt",
+      "value": "#fef5e6"
+    },
+    {
+      "name": "lime-lt",
+      "value": "#f1f8e8"
+    },
+    {
+      "name": "green-lt",
+      "value": "#eaf7ec"
+    },
+    {
+      "name": "teal-lt",
+      "value": "#e7f6f2"
+    },
+    {
+      "name": "cyan-lt",
+      "value": "#e8f6f8"
+    }
+  ],
+  "social": [
+    {
+      "name": "facebook",
+      "value": "#1877F2"
+    },
+    {
+      "name": "twitter",
+      "value": "#1da1f2"
+    },
+    {
+      "name": "linkedin",
+      "value": "#0a66c2"
+    },
+    {
+      "name": "google",
+      "value": "#dc4e41"
+    },
+    {
+      "name": "youtube",
+      "value": "#ff0000"
+    },
+    {
+      "name": "vimeo",
+      "value": "#1ab7ea"
+    },
+    {
+      "name": "dribbble",
+      "value": "#ea4c89"
+    },
+    {
+      "name": "github",
+      "value": "#181717"
+    },
+    {
+      "name": "instagram",
+      "value": "#e4405f"
+    },
+    {
+      "name": "pinterest",
+      "value": "#bd081c"
+    },
+    {
+      "name": "vk",
+      "value": "#6383a8"
+    },
+    {
+      "name": "rss",
+      "value": "#ffa500"
+    },
+    {
+      "name": "flickr",
+      "value": "#0063dc"
+    },
+    {
+      "name": "bitbucket",
+      "value": "#0052cc"
+    },
+    {
+      "name": "tabler",
+      "value": "#066fd1"
+    }
+  ]
+}

data/_data/i4y-errors.json

@@ -0,0 +1,32 @@
+{
+  "400": {
+    "title": 400,
+    "description": "We are sorry but your request contains bad syntax and cannot be fulfilled"
+  },
+  "401": {
+    "title": 401,
+    "description": "We are sorry but you are not authorized to access this page"
+  },
+  "403": {
+    "title": 403,
+    "description": "We are sorry but you do not have permission to access this page"
+  },
+  "404": {
+    "illustration": "not-found.svg",
+    "title": 404,
+    "description": "We are sorry but the page you are looking for was not found"
+  },
+  "500": {
+    "title": 500,
+    "description": "We are sorry but our server encountered an internal error"
+  },
+  "503": {
+    "title": 503,
+    "description": "We are sorry but our service is currently not available"
+  },
+  "maintenance": {
+    "illustration": "computer-fix.svg",
+    "header": "Temporarily down for maintenance",
+    "description": "Sorry for the inconvenience but we’re performing some maintenance at the moment. We’ll be back online shortly!"
+  }
+}