Skip to content

avicndugu/jekyll-shahada-theme

Repository files navigation

Shahada Academic Jekyll Theme

Shahada is a minimalist one-page academic Jekyll theme designed for researchers, scholars, and academics to showcase their work, publications, and professional information in a clean and elegant manner.

Live Demo

Shahada Academic Jekyll Theme

Theme Features

  • One Page Layout: Keep everything concise and accessible in a single page.
  • Responsive Design: Ensures your website looks great on all devices - from desktops to mobile phones.
  • Publication Showcase: Highlight your publications with ease.
  • Customizable: Easily customizable to match your personal style and preferences.
  • Easy Setup: Quick and hassle-free setup process.
  • Minimalist Design: Focuses on your content without distractions.
  • Jekyll 4.3+
  • Publish on Github Pages, Netlify, Cloudflare Pages, e.t.c.

Quick Start

Netlify Quick Setup

Netlify has a quick installation process, just click on the link and follow the steps: Netlify One Click Setup

More information on Netlify instalations

Cloudflare Pages Quick Setup

  1. Create your own copy of Shahada Academic Theme by clicking the link below. Use this template

  2. Follow the instructions on how to publish a Jekyll website on Cloudflare Pages.

Local Installation

Prerequisites

  • Ruby version 2.5+
  • Jekyll version 4.3+

For Ruby and Jekyll installation instructions, check the Jekyll docs.

Installation Steps

  1. Download or clone the theme.

  2. Navigate to the project directory and install dependencies:

bundle install
  1. Run the Jekyll server:
bundle exec jekyll serve
  1. Access your website at http://localhost:4000.

Configuration

Site Settings

Update the _config.yml file with your site-specific information:

title: Your Academic Website
description: A brief description of your website

Home Page Content

To update the home page text withou your own, update the _data/hometext.yml file with your details.

Contributing

If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request on GitHub.

License

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

  • You are not allowed to create ports of this theme
  • You are not allowed to re-sell this theme

Support My Work

If you find Shahada Academic useful, consider giving it a star on GitHub.

Thank you for using Shahada! 🚀