Supa Maven Skin

Supa Maven Skin is a modern Apache Maven Site skin inspired by Pradyun Gedam's Furo Sphinx documentation theme and built on Bootstrap 6 (6.0.0-alpha.1), Bootstrap Icons, Vite, Dart Sass (SCSS), and TypeScript.

[!NOTE] This documentation site is rendered using Supa Maven Skin itself! Try toggling between Light, Dark, and Auto themes or switching accessible color schemes in the top utility bar, or pressing / (⌘K / Ctrl+K) to open the search dialog.

Documentation Guide

Explore the documentation by goal:

Quickstart Tutorial Tutorial

Step-by-step guide to configuring pom.xml and site.xml and writing your first .md and .md.vm pages.

Authoring Rich Content How-To Guide

Practical recipes for Furo admonitions, Bootstrap Icons, code blocks, synchronized tabs, accordions, Mermaid, and KaTeX.

Customizing the Skin How-To Guide

Add your own css/site.css, extra <head> content, and design-token overrides without forking the skin.

Migrating from Fluido How-To Guide

Switch an existing site from Apache Maven Fluido Skin with an option-by-option mapping and a verification checklist.

Troubleshooting How-To Guide

Symptom, cause, and fix for vanishing headings, unhighlighted code, missing diagrams, previews, and more.

Configuration & Macros Reference

Complete lookup tables for <supaSkin> options, WCAG 2.2 AA/AAA color schemes, CSS variables, and Velocity macros.

Components Reference

Interactive playground and catalog for all 28 Bootstrap 6 component families, 20 JS plugins, and 2,000+ Bootstrap Icons.

Kitchen Sink Showcase Reference

Visual stress-test of all 12 Furo admonitions, syntax-highlighted code blocks, responsive Doxia tables, Mermaid diagrams, and KaTeX math.

Architecture & Color System Explanation

Deep dive into the 3-column Furo layout, Doxia 2.0 normalization, .prose isolation, and WCAG 2.2 AA/AAA contrast guarantees.

Minimal Quickstart

Add Supa Maven Skin to your project's src/site/site.xml:

<skin>
  <groupId>io.github.mepcotterell</groupId>
  <artifactId>supa-maven-skin</artifactId>
  <version>0.2.0</version>
</skin>

Then generate your site with maven-site-plugin 3.21.0+:

mvn site

For a full walkthrough, head to the Quickstart Tutorial or jump straight to Authoring Rich Content.