Documentation

Complete guide to using the Neubrutalist Jekyll theme

Version: 1.0.0 Updated: Mar 2, 2026

Welcome to the Documentation

This documentation will help you get started with the Neubrutalist Jekyll Theme and make the most of its bold, beautiful features.

This is an interactive documentation site built with the docs layout. Use the sidebar to navigate between sections.

What is Neubrutalism?

Neubrutalism (or Neo-Brutalism) is a design trend that embraces:

  • Thick Borders - 4px solid borders everywhere
  • Hard Shadows - 8px offset shadows with no blur
  • Bright Colors - Hot pink, cyan, yellow, and more
  • Bold Typography - Space Grotesk and Space Mono fonts
  • Honest Design - Raw, unapologetic aesthetics

Theme Features

Layouts

The theme includes 5 different layouts:

  1. default - Base layout with header and footer
  2. home - Homepage with hero section and blog posts
  3. page - Simple content pages
  4. post - Blog post layout
  5. docs - Technical documentation (youโ€™re looking at it!)

Components

  • Responsive navigation
  • Hero sections
  • Blog post listings
  • Code syntax highlighting
  • Callout boxes (notes, warnings, tips)
  • Tables with neubrutalist styling
  • Custom 404 page

Colors

--color-primary: #FF006E    /* Hot Pink */
--color-secondary: #00F5FF  /* Cyan */
--color-accent: #FFBE0B     /* Yellow */
--color-success: #06FFA5    /* Mint Green */
--color-border: #000000     /* Black */

Quick Examples

Code Blocks

Code blocks are styled with black backgrounds and green text:

function greet(name) {
  return `Hello, ${name}!`;
}

console.log(greet('World'));

Callout Boxes

๐Ÿ’ก Tip: Use callout boxes to highlight important information!
โš ๏ธ Warning: Make sure to test your site locally before deploying.

Tables

Feature Description Status
Responsive Mobile-friendly design โœ…
Fast Pure CSS, no frameworks โœ…
Bold Thick borders and shadows โœ…
Documented Complete guides โœ…

Documentation Sections

Explore the documentation using the sidebar:

  • Getting Started - Installation and setup
  • Configuration - Customize your site
  • Layouts - Available page templates
  • Components - Built-in components and styles
  • Deployment - Publishing your site

Need Help?

If you run into any issues or have questions:

  1. Check the documentation sections in the sidebar
  2. Review the example files
  3. Open an issue on GitHub
๐Ÿ“˜ Note: This documentation is a work in progress. Contributions are welcome!

Whatโ€™s Next?

Ready to get started? Head to the Getting Started guide to install and configure the theme.