🧞‍♀️ Luma

A minimalist dark blog theme for Jekyll

📑 Table of Contents

Features
Requirements
Quick Start
GitHub Pages Deployment
Configuration
Customization
File Structure
Development
Contributing
License

✨ Features

Feature	Description
🌙 Dark Design	Elegant minimalist dark theme, easy on the eyes
📱 Responsive	Fully mobile-friendly and adapts to all screen sizes
⚡ Performance	Optimized for fast load times and SEO
📊 Analytics	Built-in Google Analytics support
🎨 Customizable	Built with Sass for easy styling modifications
🔌 Easy Setup	Simple gem installation, works out of the box
🐙 GitHub Pages	Compatible with GitHub Pages hosting

📋 Requirements

Ruby >= 2.7
Jekyll >= 4.2
Bundler >= 2.0

🚀 Quick Start

1. Add Luma to your Gemfile

gem "luma-jekyll"

2. Set the theme in `_config.yml`

theme: luma-jekyll

3. Install dependencies

bundle install

4. Start your site

bundle exec jekyll serve

Visit http://localhost:4000 to see your site in action.

🐙 GitHub Pages Deployment

To use Luma with GitHub Pages, use the jekyll-remote-theme plugin:

1. Update your `Gemfile`

gem "jekyll-remote-theme"

2. Configure `_config.yml`

plugins:
  - jekyll-remote-theme

remote_theme: AlexsandroSA/luma-jekyll

3. Push to GitHub

Commit and push your changes. GitHub Pages will automatically build and deploy your site.

⚙️ Configuration

Customize your site by editing _config.yml:

# Site Settings
title: Your Site Title
description: A brief description of your site
url: https://yourdomain.com
baseurl: ""

# Author
author:
  name: Your Name
  email: your@email.com

# Social Links
social:
  github: your-username
  twitter: your-handle
  linkedin: your-profile

# Analytics
google_analytics: UA-XXXXXXXX-X

🎨 Customization

Overriding Theme Files

Copy any file from the theme's directories into your site to customize:

Directory	Purpose
`_layouts/`	Page templates (default, home, post, page)
`_includes/`	Reusable components (header, footer, head)
`_sass/`	Sass partials and variables
`assets/`	CSS, images, and static files

Custom Styles

Create or edit assets/css/style.scss in your site:

---
---

// Override variables before importing the theme
$primary-color: #E9967A;
$background-color: #1a1a1a;

@import "luma";

Adding Pages

Create Markdown or HTML files in your site root:

---
layout: page
title: About
permalink: /about/
---

Your content here...

📁 File Structure

luma-jekyll/
├── _includes/
│   ├── footer.html
│   ├── google-analytics.html
│   ├── head.html
│   └── header.html
├── _layouts/
│   ├── default.html
│   ├── home.html
│   ├── page.html
│   └── post.html
├── _posts/
│   └── (your blog posts)
├── assets/
│   ├── css/
│   │   └── style.scss
│   └── image/
│       └── favicon.ico
├── _config.yml
└── index.html

🧑‍💻 Development

To contribute to or modify the theme:

# Clone the repository
git clone https://github.com/AlexsandroSA/luma-jekyll.git
cd luma-jekyll

# Install dependencies
bundle install

# Start development server
bundle exec jekyll serve --livereload

Building the Gem

gem build luma-jekyll.gemspec
gem push luma-jekyll-*.gem

Note: Only files in _layouts, _includes, _sass, and assets are bundled in the gem. Update the regexp in luma-jekyll.gemspec to include additional files.

🤝 Contributing

Contributions are welcome! Here's how you can help:

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Please read our Contributing Guidelines and follow the Contributor Covenant code of conduct.

📄 License

Distributed under the MIT License. See LICENSE.txt for more information.

Made with ♥ by Alexsandro Alves

⭐ Star this repo if you find it useful!

luma-jekyll

Development

Runtime