insights4you-jekyll-theme 0.4.0
<div> # 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.  [][repo] [][build] [][codacy] [][gem] [][gem] [][license] </div> ## ๐ 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 ``` 5. **Install dependencies:** ```bash bundle install ``` 6. **Start your site:** ```bash bundle exec jekyll serve ``` ## ๐ฏ Demo Site To see the theme in action, check out the included example site: ```bash # 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 [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 [license]: https://github.com/marciopaiva/insights4you-jekyll-theme/blob/master/LICENSE