84 lines
2.9 KiB
Markdown
84 lines
2.9 KiB
Markdown
<div align="center">
|
|
<img src="https://git.djeex.fr/Djeex/lumeex/raw/branch/main/illustration/logo.svg" alt="Lumeex Screenshot" width="400"/>
|
|
</div>
|
|
<p/>
|
|
<div align="center">
|
|
<p>Yet another minimalist, lightweight photo gallery static site generator.</p>
|
|
</div>
|
|
</p>
|
|
<div align="center">
|
|
<img src="https://git.djeex.fr/Djeex/lumeex/raw/branch/main/illustration/lumeex.png" alt="Lumeex Screenshot" />
|
|
</div>
|
|
|
|
Lumeex is a static site generator designed to create minimalist photo galleries that highlight your artworks over the author. It empowers users to organize and explore images using tags, with each page load presenting photos in a random order to encourage discovery of new content.
|
|
|
|
The project includes two thoughtfully designed themes—one modern, one minimalistic—both crafted to keep the spotlight on your photos:
|
|
|
|
- **Modern** — [View Demo](https://modern.djeex.fr)
|
|
- **Typewriter** — [View Demo](https://typewriter.djeex.fr)
|
|
|
|
> [!NOTE]
|
|
> This GitHub repository is a mirror of the primary source at [git.djeex.fr/Djeex/lumeex](https://git.djeex.fr/Djeex/lumeex). The main repository includes the full history, releases, and bug-checking assisted by an LLM.
|
|
|
|
|
|
## 📌 Table of Contents
|
|
|
|
- [✨ Features](#-features)
|
|
- [🐍 Python Installation](#-python-installation)
|
|
- [⚙️ Configuration](#-configuration)
|
|
|
|
|
|
## ✨ Features
|
|
|
|
### Gallery (Static Website)
|
|
|
|
- Photos displayed in a new random order with every page load
|
|
- Tag-based filtering with multi-tag support
|
|
- Shareable URLs that retain active tag filters
|
|
- Photo carousel on the homepage
|
|
- Legal notice page included
|
|
- Two customizable visual themes:
|
|
- Modern — [Demo](https://modern.djeex.fr)
|
|
- Typewriter — [Demo](https://typewriter.djeex.fr)
|
|
- Supports Google Fonts and locally hosted fonts
|
|
|
|
### No-Code Builder (YAML Based)
|
|
|
|
- Configure site info, SEO, colors, fonts, and more through simple YAML files
|
|
- Reference and tag photos without any coding required
|
|
- *(Optional)* Automatically update photo references via script
|
|
|
|
### Simple Build Process
|
|
|
|
- Compiles static site from YAML configuration files (themes, templates, fonts, colors)
|
|
- Converts favicon automatically to all required formats
|
|
- Resizes social sharing thumbnails
|
|
- *(Optional)* Automatically resizes photos to a maximum width of 1140px
|
|
- *(Optional)* Converts images to WebP format for optimized performance
|
|
- Outputs a complete static website ready to deploy on any web server
|
|
|
|
|
|
## 🐍 Python Installation
|
|
|
|
Run the Python scripts directly with the following prerequisites:
|
|
|
|
### Prerequisites
|
|
|
|
- Git
|
|
- Python 3.11 or above
|
|
|
|
### Installation Steps
|
|
|
|
```sh
|
|
git clone https://git.djeex.fr/Djeex/lumeex.git
|
|
cd lumeex
|
|
python3 -m venv .venv
|
|
source .venv/bin/activate
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
You are now ready to use Lumeex!
|
|
|
|
### ⚙️ Configuration
|
|
For comprehensive documentation on configuration options, customization, and demos, please visit:
|
|
https://lumeex.djeex.fr |