🌟 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
gem install insights4you-jekyll-theme
- Create a new Jekyll site:
jekyll new my-website
- Add the theme to your Jekyll site's
Gemfile
:
gem "insights4you-jekyll-theme"
theme: insights4you-jekyll-theme
bundle install
bundle exec jekyll serve
🎯 Demo Site
To see the theme in action, check out the included example site:
git clone https://github.com/marciopaiva/insights4you-jekyll-theme.git
cd insights4you-jekyll-theme
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:
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
)
- Commit your changes (
git commit -m 'Add amazing feature'
)
- Push to the branch (
git push origin feature/amazing-feature
)
- 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