Welcome to ResearchHub, your ultimate blog platform for sharing and exploring knowledge across diverse topics such as yoga, mindset, self-help, leadership and more. This repository contains a dynamic, responsive, and modern blog application built with Jekyll and enhanced with Bootstrap and JavaScript for client-side filtering and interactivity.
- Dynamic Blog Posts: Easily add blog posts using Markdown files in the
_posts
directory. - Responsive Design: Fully responsive layout using Bootstrap 5, optimized for all devices.
- Category Filtering: Filter posts dynamically by categories with interactive buttons.
- Client-Side Pagination: Paginate posts without relying on plugins using JavaScript.
- Modern UI: Clean, gradient-based card designs with hover effects and dynamic styling.
- Easy Deployment: Deploy seamlessly to GitHub Pages.
.
├── _layouts/ # Layout templates for your site
│ ├── default.html # Default layout template
│ ├── home.html # Home page layout template
├── _posts/ # Markdown files for blog posts
│ ├── 2025-01-01-example.md # Example post
├── _config.yml # Jekyll configuration file
├── index.md # Home page content
├── README.md # Documentation (this file)
Follow these steps to run ResearchHub locally:
-
Clone the Repository:
git clone https://github.com/sehaj97/researchhub.git cd researchhub
-
Install Jekyll: Ensure you have Ruby and Bundler installed. Then, install Jekyll:
gem install bundler jekyll
-
Install Dependencies: Install all required dependencies with Bundler:
bundle install
-
Run the Development Server: Start the Jekyll server locally:
bundle exec jekyll serve
-
Access the Blog: Open your browser and go to:
http://localhost:4000
-
Navigate to the
_posts
directory. -
Create a new file with the naming convention:
YYYY-MM-DD-title.md
. -
Add the following front matter to the file:
--- layout: post title: "Your Blog Post Title" date: 2025-01-01 categories: [yoga, mindset] ---
-
Write your content in Markdown below the front matter.
To add new categories with custom colors:
-
Update the
category_color_map
in_config.yml
:category_color_map: yoga: "bg-success" mindset: "bg-primary" HowTo: "bg-warning" self-help: "bg-info" book: "bg-info" default: "bg-secondary"
- Push your changes to the
main
branch (or your preferred branch). - Go to Settings → Pages in your repository.
- Set the source branch to
main
and the folder to/ (root)
. - Your blog will be live at
https://<your-username>.github.io/researchhub
.
We welcome contributions to improve ResearchHub! To contribute:
- Fork the repository.
- Create a feature branch (
git checkout -b feature/your-feature
). - Commit your changes (
git commit -m "Add your feature"
). - Push to your branch (
git push origin feature/your-feature
). - Open a Pull Request.
This project is licensed under the MIT License.
- Built with Jekyll
- UI powered by Bootstrap 5
- Dynamic interactivity using vanilla JavaScript