🧞‍♀️ Luma

A minimalist dark blog theme for Jekyll

Live Demo · Changelog · Report Bug

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

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

gem "luma-jekyll"

theme: luma-jekyll

bundle install

bundle exec jekyll serve

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

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

gem "jekyll-remote-theme"

plugins:
  - jekyll-remote-theme

remote_theme: AlexsandroSA/luma-jekyll

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

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

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

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

---
---

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

@import "luma";

Create Markdown or HTML files in your site root:

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

Your content here...

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

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

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.

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

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

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

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