HTML Apache-2.0

personal-jekyll-theme

{ Personal } Jekyll theme

L

le4ker

Dernière activité 26 sept. 2026
le4ker/personal-jekyll-theme

648

étoiles

636

forks

0

issues ouvertes

jekylljekyll-blogjekyll-sitejekyll-theme

Ce README est souvent en anglais.

{ Personal } Jekyll Theme

Build Status GitHub license Ruby Jekyll

{ Personal } is a free, responsive Jekyll theme with a minimal aesthetic — perfect for your personal blog and portfolio. Tell your story with a beautiful timeline and share your thoughts through an elegant blog.

🔗 Live Demo

Theme Demo


🚀 Quick Start

Deploy on GitHub Pages (Free)

  1. Fork this repository
  2. Rename the forked repository to yourusername.github.io
  3. Update _config.yml:
    url: "https://yourusername.github.io"
    baseurl: ""
  4. Commit your changes — once the GitHub Action succeeds, your site will be live at https://yourusername.github.io

💻 Local Development

No need to install Ruby or dependencies locally:

docker-compose up --build

The site will be available at http://localhost:4000.

Option 2: Native Ruby

Prerequisites:

  • Ruby 3.1.1 (use rbenv or rvm for version management)
  • Bundler

Installation:

# Install dependencies
bundle install

# Start the development server with live reload
bundle exec jekyll serve --watch --livereload

The site will be available at http://localhost:4000.


⚙️ Configuration

All site configuration is managed through _config.yml. Key settings include:

Setting Description
url Your site's URL
title Site title displayed in the header
author Your name
description Site description for SEO
me-img Your profile image
background-img Header background image
events Timeline entries
social Social media links

✨ Features

Design

  • 🎨 Modern, minimal aesthetic with white-on-black text
  • 🌗 Dark mode with a theme toggle button — preference saved in localStorage
  • 📱 Fully responsive — looks great on mobile, tablet, and desktop
  • 🖼️ Customizable header with dynamic text and profile image

Timeline

  • 📅 Tell your story with a sleek timeline
  • 🖼️ Add images, dates, and descriptions for each milestone

Blogging

  • ✍️ Full-featured blog with archive page
  • 🏷️ Hashtags and categories support
  • 💬 Comments integration (Cusdis) with dark/light theme sync
  • 🔗 Social share buttons (X, Facebook, LinkedIn, Reddit, Hacker News, and more)
  • 🎨 Syntax highlighting for code blocks
  • 📊 Mermaid diagram support
  • 📡 RSS feed

SEO & Analytics

  • 📈 Google Analytics integration
  • 🗺️ Automatic sitemap generation
  • 🔍 SEO-friendly meta tags

Privacy & Security

  • 🍪 Cookie consent banner
  • 🛡️ Email harvesting protection

📚 Documentation

Detailed documentation is available as blog posts on the demo site.


🤝 Contributing

This project uses Conventional Commits to generate release notes automatically.

Setup Git Hooks

To enforce conventional commits locally, run:

sh .githooks/setup.sh

This will configure git to validate your commit messages before each commit.

Commit Message Format

<type>[optional scope]: <description>

Allowed types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert

Examples:

feat: add dark mode support
fix(comments): resolve Cusdis loading issue
docs: update installation instructions

🙏 Credits

This theme is a fork of Timeline, which is a mashup of:


📄 License

This project is licensed under the Apache License 2.0 — see the LICENSE file for details.

Projets similaires

💎 🐳 A super customizable Jekyll theme for personal site, team site, blog, project, documentation, etc.

SCSSjekylljekyll-templatejekyll-theme
Kkitian616
3,3 k étoiles2,7 k

My Blog / Jekyll Themes / PWA

HTMLblog-themejekyll-themejekyll-themes
HHuxpro
7,6 k étoiles6,6 k

Jekyll theme for building a personal site, blog, project documentation, or portfolio.

HTMLalgoliaalgolia-searchgithub-pages
Mmmistakes
13,6 k étoiles27,2 k