Getting Started
Learn how to install and configure the Neubrutalist Jekyll theme
Installation
The Neubrutalist theme can be installed in three different ways, depending on your needs.
Method 1: GitHub Pages (Remote Theme)
This is the easiest method for GitHub Pages users.
- Add to your
_config.yml:
remote_theme: cryptonym0/jekyll-theme-danish-pastel
plugins:
- jekyll-feed
- jekyll-seo-tag
- Create your
index.md:
---
layout: home
---
- Push to GitHub and enable GitHub Pages in settings
💡 This method automatically updates when the theme repository changes!
Method 2: Ruby Gem
Install as a Ruby gem for traditional Jekyll sites.
- Add to your
Gemfile:
gem "jekyll-theme-danish-pastel"
- Update
_config.yml:
theme: jekyll-theme-danish-pastel
- Install:
bundle install
Method 3: Direct Copy
Copy the theme files directly into your project for maximum customization.
- Download or clone the theme repository
- Copy
_layouts/andassets/to your site - Update your
_config.ymlconfiguration
⚠️ This method requires manual updates when the theme changes.
Basic Configuration
After installation, configure your site in _config.yml:
title: Your Site Title
description: Your site description
url: "https://yourdomain.com"
baseurl: ""
# Optional: Enable GitHub edit links
github_repo: "https://github.com/yourusername/your-repo"
# Build settings
markdown: kramdown
plugins:
- jekyll-feed
- jekyll-seo-tag
Creating Content
Homepage
Create index.md with the home layout:
---
layout: home
---
The home layout includes:
- Hero section with bold title
- Automatic blog post listing
- Responsive design
Pages
Create content pages:
---
layout: page
title: About
permalink: /about/
---
Your content here...
Blog Posts
Create posts in _posts/:
---
layout: post
title: "Your Post Title"
date: 2026-03-02
categories: blog design
---
Your post content...
Posts must follow the naming convention: YYYY-MM-DD-title.md
Documentation
Create docs in docs/ folder:
---
layout: docs
title: Your Doc Page
category: Documentation
order: 2
---
Your documentation content...
Testing Locally
Run your site locally to preview changes:
# Install dependencies
bundle install
# Start Jekyll server
bundle exec jekyll serve
# Open browser
# Visit http://localhost:4000
📘 The server will auto-reload when you make changes to files.
Project Structure
Your site should have this structure:
your-site/
├── _config.yml # Site configuration
├── index.md # Homepage
├── about.md # About page
│
├── _posts/ # Blog posts
│ └── 2026-03-02-post.md
│
├── docs/ # Documentation
│ ├── index.md
│ └── getting-started.md
│
├── assets/
│ └── images/
│
└── Gemfile # Ruby dependencies
Next Steps
Now that your theme is installed, learn how to:
- Configure colors and settings
- Use layouts for different page types
- Add components like callouts and tables
- Deploy to GitHub Pages or other hosts
💡 Tip: Check out the example pages included with the theme for inspiration!
Troubleshooting
Theme not loading
- Verify
remote_themeorthemeis set correctly - Check that all required plugins are installed
- Run
bundle installagain
Styles not applying
- Clear your browser cache
- Restart the Jekyll server
- Check that
assets/css/style.cssexists
Build errors
- Check Jekyll version compatibility (4.3+)
- Verify all required gems are installed
- Review error messages in terminal
📘 Still having issues? Open an issue on GitHub with your error message and configuration.