Skip to content

E-Segments/minima-plus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

✨ Minima+ ✨

A beautiful, minimal Jekyll theme powered by Tailwind CSS v4

The next evolution of Jekyll's classic Minima theme β€” now with dark mode, search, pagination, and zero build steps.

Jekyll Tailwind CSS License GitHub Pages

🌐 Live Demo β€’ πŸ“– Documentation β€’ πŸ“‹ Changelog


Minima+ Preview

🎯 Why Minima+?

Feature Minima (Classic) Minima+
Dark Mode ❌ βœ…
Tailwind CSS ❌ βœ…
No Build Step βœ… βœ…
Responsive ⚠️ Basic βœ… Full
Blog + Docs ⚠️ Blog only βœ… Both
πŸ” Search (Lunr.js) ❌ βœ…
πŸ“„ Pagination ❌ βœ…
πŸ“‹ Changelog ❌ βœ…
🏷️ Badges ❌ βœ…
πŸ“Š Stats Counter ❌ βœ…
πŸ—‚οΈ Tabs & Accordions ❌ βœ…
πŸ“š Versioned Docs ❌ βœ…
πŸ“‘ API Reference ❌ βœ…
πŸ’» CLI Reference ❌ βœ…
🚫 404 Page ⚠️ Basic βœ… Animated
πŸš€ Coming Soon ❌ βœ…
Syntax Highlighting ⚠️ Rouge βœ… Prism.js
Copy Code Button ❌ βœ…
Table of Contents ❌ βœ…
SEO Optimized ⚠️ Basic βœ… Full

✨ Features

🎨 Design

  • 🌈 16 Color Themes β€” One line config change
  • πŸŒ™ Dark Mode β€” Auto-detects system preference
  • πŸ“± Fully Responsive β€” Mobile-first design
  • ✏️ Beautiful Typography β€” Tailwind's prose classes
  • 🚫 Animated 404 β€” Creative error page
  • πŸš€ Coming Soon β€” Pre-launch landing page

⚑ Performance

  • πŸš€ No Build Step β€” Tailwind via CDN
  • πŸ“¦ Static Output β€” Lightning fast
  • πŸ” SEO Ready β€” Meta tags, sitemap, Open Graph
  • β™Ώ Accessible β€” WCAG compliant

πŸ“ Content

  • πŸ“° Blog Ready β€” Categories, tags, reading time
  • πŸ“š Documentation β€” Sidebar + versioning
  • πŸ“‘ API Reference β€” REST endpoint docs
  • πŸ’» CLI Reference β€” Command documentation
  • πŸ” Search β€” Lunr.js powered, Cmd+K shortcut
  • πŸ“‹ Changelog β€” Auto-fetch from GitHub releases

πŸ› οΈ Developer Experience

  • βš™οΈ Configurable β€” Everything in _config.yml
  • πŸ“„ Pagination β€” For blog, docs, and releases
  • 🏷️ Badges β€” Shields.io integration
  • πŸ“Š Stats Counter β€” Animated number counters
  • πŸ—‚οΈ Tabs & Accordions β€” Interactive components
  • πŸ€– Auto Deploy β€” GitHub Actions included

πŸš€ Quick Start

πŸ†• Starting Fresh? Use the Template!

Use Template
  1. Click "Use this template" above
  2. Name your repo username.github.io (for personal site) or any name
  3. Clone β†’ Edit _config.yml β†’ Push
  4. πŸŽ‰ Your site is live!

πŸ“¦ Adding to Existing Repo? Use Remote Theme!

Step 1: Create docs/_config.yml:

remote_theme: E-Segments/minima-plus
baseurl: "/your-repo-name"

title: "My Project"
description: "Documentation for my awesome project"
github_repo: "username/repo"  # For changelog

theme_config:
  colors:
    primary: "emerald"
  features:
    search: true

Step 2: Create docs/Gemfile:

source "https://rubygems.org"
gem "jekyll", "~> 4.3"
gem "jekyll-remote-theme"
gem "jekyll-paginate-v2"

Step 3: Enable GitHub Pages:

Settings β†’ Pages β†’ Branch: main β†’ Folder: /docs

Step 4 (Optional): Add 404 and Coming Soon pages:

Create docs/404.html:

---
layout: 404
title: "Page not found"
permalink: /404.html
---

Create docs/coming-soon.html (for pre-launch):

---
layout: coming-soon
title: "Coming Soon"
headline: "Something Amazing is Coming"
launch_date: "2025-06-01T00:00:00"
permalink: /coming-soon/
---
Note: When using remote_theme, layouts like 404, coming-soon, api, and cli are automatically available from the theme.

πŸ†• New Features

πŸ” Search (Cmd+K)

Full-text search across posts, docs, and pages powered by Lunr.js.

  • Press Cmd+K (Mac) or Ctrl+K (Windows/Linux) to open
  • Filter by content type (All / Posts / Docs)
  • Keyboard navigation with arrow keys
  • Recent searches saved locally

Enable in _config.yml:

theme_config:
  features:
    search: true

πŸ“„ Pagination

Built-in pagination for blog posts using jekyll-paginate-v2.

  • Configurable posts per page
  • Previous/Next navigation
  • Page numbers with ellipsis
  • "Showing X-Y of Z" counter

Configure in _config.yml:

pagination:
  enabled: true
  per_page: 6
  permalink: '/page/:num/'

πŸ“‹ Changelog

Auto-fetch releases from GitHub API with search and filtering.

  • Pulls releases from your GitHub repo
  • Search and filter releases
  • Version badges and download links
  • Markdown release notes rendered

Set your repo in _config.yml:

github_repo: "username/repo"

Then create changelog.md:

---
layout: changelog
title: Changelog
permalink: /changelog/
---

🏷️ Badges (Shields.io)

Easy badge integration with Shields.io and Badgen.net.

{% include components/badge.html
   label="Jekyll"
   message="4.3+"
   color="CC0000"
   logo="jekyll"
   style="for-the-badge"
%}

{% include components/badge.html
   type="github/v/release"
   repo="E-Segments/minima-plus"
   style="flat-square"
%}

Or use badge groups from data:

{% include components/badge-group.html badges=site.data.badges.theme %}

πŸ“Š Stats Counter

Animated number counters that count up when scrolled into view.

{% include components/stats-counter.html
   stats="10K+:Downloads,500+:Stars,50+:Contributors,99%:Satisfaction"
   style="cards"
   columns=4
%}

Or use data arrays:

# In front matter
stats:
  - value: 10000
    label: "Downloads"
    suffix: "+"
  - value: 99.9
    label: "Uptime"
    suffix: "%"
    decimals: 1

Styles: default, cards, minimal

πŸ—‚οΈ Tabs & Accordions

Interactive tabbed content and collapsible sections.

Tabs:

{% include components/tabs.html id="demo" tabs="HTML,CSS,JS" %}
<div data-tab-content="demo-0">HTML content</div>
<div data-tab-content="demo-1">CSS content</div>
<div data-tab-content="demo-2">JS content</div>
{% include components/tabs.html id="demo" end=true %}

Accordion:

{% include components/accordion.html items=page.faq %}

With front matter:

faq:
  - question: "What is Jekyll?"
    answer: "A static site generator."
  - question: "Is it free?"
    answer: "Yes, completely free."

Styles: default, bordered, separated | Tab styles: underline, pills

πŸ“š Versioned Documentation

Support multiple documentation versions with a dropdown selector.

Configure in _data/versions.yml:

current: "2.0"
versions:
  - number: "2.0"
    name: "v2.0 (Latest)"
    path: "/docs/"
    latest: true
  - number: "1.0"
    name: "v1.0"
    path: "/docs/v1/"

Features:

  • Version dropdown in docs sidebar
  • Warning banner for old versions
  • Automatic "latest" detection
  • localStorage preference saving

🚫 404 Error Page

Beautiful animated 404 page with:

  • Gradient animated "404" text
  • Floating particles background
  • Built-in search box
  • Auto-populated navigation suggestions
  • Rotating fun error messages

GitHub Pages automatically uses 404.html β€” no configuration needed!

Customize in 404.html:

---
layout: 404
title: "Page not found"
description: "Custom message here"
---

πŸš€ Coming Soon Page

Pre-launch landing page with countdown timer and email capture.

---
layout: coming-soon
title: "Coming Soon"
headline: "Something Amazing is Coming"
tagline: "Sign up to be notified!"
launch_date: "2025-06-01T00:00:00"
social:
  - name: "Twitter"
    icon: "twitter"
    url: "https://twitter.com/handle"
  - name: "GitHub"
    icon: "github"
    url: "https://github.com/repo"
# form_action: "https://your-email-service.com/subscribe"
---

Features:

  • Live countdown timer
  • Email signup form
  • Social links (Twitter, GitHub, LinkedIn, Instagram, Discord)
  • Animated glowing background
  • Mobile responsive

Pre-launch tip: Rename coming-soon.html to index.html until launch!

πŸ“‘ API Reference Layout

Document REST APIs with method badges, parameters, and response codes.

---
layout: api
title: API Reference
api_version: "v1"
base_url: "https://api.example.com/v1"
endpoints:
  - method: "GET"
    path: "/users"
    description: "List all users"
    auth: "required"
    params:
      - name: "page"
        type: "integer"
        in: "query"
    responses:
      - status: 200
        description: "Success"
---

Features:

  • Method badges (GET, POST, PUT, DELETE)
  • Parameter tables (query, path, body)
  • Response status codes
  • Sidebar navigation

πŸ’» CLI Reference Layout

Document command-line tools with arguments, options, and examples.

---
layout: cli
title: CLI Reference
cli_name: "mytool"
cli_version: "1.0.0"
commands:
  - name: "init"
    description: "Initialize a new project"
    usage: "mytool init [options]"
    options:
      - flag: "-f, --force"
        description: "Force overwrite"
    examples:
      - title: "Basic usage"
        code: "mytool init my-project"
---

Features:

  • Command documentation
  • Arguments and options tables
  • Code examples with output
  • Terminal-style headers

🎨 Color Themes

Change your entire site's color scheme with one line:

theme_config:
  colors:
    primary: "indigo"  # Change this!

Available colors: red, orange, amber, emerald, blue, violet, pink, rose, purple, cyan, teal, indigo, slate, gray, zinc, neutral, stone, yellow, lime, green, sky, fuchsia


πŸ“ Project Structure

your-site/
β”œβ”€β”€ _config.yml          # Site configuration
β”œβ”€β”€ _data/
β”‚   β”œβ”€β”€ navigation.yml   # Header menu
β”‚   β”œβ”€β”€ social.yml       # Social links
β”‚   β”œβ”€β”€ footer.yml       # Footer columns
β”‚   β”œβ”€β”€ badges.yml       # Badge definitions
β”‚   └── versions.yml     # Doc versions
β”œβ”€β”€ _docs/               # Documentation pages
β”œβ”€β”€ _posts/              # Blog posts
β”œβ”€β”€ _layouts/
β”‚   β”œβ”€β”€ default.html     # Base layout
β”‚   β”œβ”€β”€ post.html        # Blog post
β”‚   β”œβ”€β”€ docs.html        # Documentation
β”‚   β”œβ”€β”€ api.html         # API reference
β”‚   β”œβ”€β”€ cli.html         # CLI reference
β”‚   β”œβ”€β”€ changelog.html   # GitHub releases
β”‚   β”œβ”€β”€ 404.html         # Error page
β”‚   └── coming-soon.html # Pre-launch page
β”œβ”€β”€ _includes/
β”‚   β”œβ”€β”€ components/      # UI components
β”‚   β”‚   β”œβ”€β”€ badge.html
β”‚   β”‚   β”œβ”€β”€ badge-group.html
β”‚   β”‚   β”œβ”€β”€ card.html
β”‚   β”‚   β”œβ”€β”€ button.html
β”‚   β”‚   β”œβ”€β”€ tabs.html
β”‚   β”‚   β”œβ”€β”€ accordion.html
β”‚   β”‚   β”œβ”€β”€ stats-counter.html
β”‚   β”‚   β”œβ”€β”€ endpoint.html
β”‚   β”‚   β”œβ”€β”€ cli-command.html
β”‚   β”‚   └── version-selector.html
β”‚   β”œβ”€β”€ search.html      # Search modal
β”‚   └── pagination.html
β”œβ”€β”€ assets/
β”‚   β”œβ”€β”€ css/custom.css   # Custom styles
β”‚   └── search.json      # Search index
β”œβ”€β”€ blog/                # Blog listing
β”œβ”€β”€ docs/                # Docs listing
β”œβ”€β”€ api.md               # API docs example
β”œβ”€β”€ cli.md               # CLI docs example
β”œβ”€β”€ changelog.md         # Changelog page
β”œβ”€β”€ coming-soon.html     # Coming soon page
β”œβ”€β”€ 404.html             # 404 error page
└── index.html           # Homepage

βš™οΈ Configuration

Full _config.yml options:

# Site Basics
title: "My Site"
description: "My awesome site"
author: "Your Name"
url: "https://username.github.io"
baseurl: "/repo-name"

# GitHub repo for changelog
github_repo: "username/repo"

# Plugins
plugins:
  - jekyll-feed
  - jekyll-seo-tag
  - jekyll-sitemap
  - jekyll-paginate-v2

# Pagination
pagination:
  enabled: true
  per_page: 6
  permalink: '/page/:num/'

# Theme Configuration
theme_config:
  colors:
    primary: "indigo"
    secondary: "slate"
    accent: "amber"

  components:
    show_toc: true
    show_reading_time: true
    show_date: true
    show_author: true
    show_tags: true
    show_categories: true

  features:
    dark_mode: true
    search: true

# Analytics (optional)
analytics:
  google_analytics: "G-XXXXXXXXXX"
  plausible: "your-domain.com"

🧩 Components

Badges

{% include components/badge.html
   service="shields"
   type="github/stars"
   repo="E-Segments/minima-plus"
   style="for-the-badge"
%}

Callouts

<div class="callout callout-info">
  <strong>Pro Tip:</strong> This is helpful information!
</div>

Cards Grid

<div class="not-prose cards-grid">
  <a href="/docs/" class="card">
    <div class="card-title">Documentation</div>
    <div class="card-description">Learn how to use Minima+</div>
  </a>
</div>

Steps List

<ol class="steps">
  <li>First, do this</li>
  <li>Then, do that</li>
  <li>Finally, celebrate!</li>
</ol>

πŸš€ Deployment

GitHub Pages (Automatic)

This template includes GitHub Actions for automatic deployment!

  1. Go to Settings β†’ Pages
  2. Under Build and deployment, select GitHub Actions
  3. Push to main branch
  4. Your site deploys automatically!

Custom Domain

  1. Create a CNAME file with your domain
  2. Configure DNS at your registrar
  3. Enable Enforce HTTPS in Pages settings

🀝 Contributing

Contributions are welcome! Feel free to:

  • Report bugs
  • Suggest features
  • Submit pull requests

πŸ“„ License

MIT License β€” use it for anything! Free forever.


πŸ’– Credits

Built with:


Star this repo if you find it useful!

Made with care by E-Segments

About

A minimal, modern Jekyll theme with Tailwind CSS v4

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors