Djeex/lumeex
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity

Better readme

Browse Source
This commit is contained in:
Djeex
2025-08-11 12:36:40 +00:00
parent 080209d202
commit 7f86f8f522
1 changed files with 54 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
README.MD
View File

@ -1,62 +1,70 @@
<h1 align="center">Lumeex</h1>
<div align="center" >
<img src="https://git.djeex.fr/Djeex/lumeex/raw/branch/main/illustration/lumeex.png" alt="Lumeex Screenshot">
<div align="center">
<img src="https://git.djeex.fr/Djeex/lumeex/raw/branch/main/illustration/lumeex.png" alt="Lumeex Screenshot" />
</div>
<div align="center">
<img src="https://git.djeex.fr/Djeex/lumeex/raw/branch/main/illustration/lumeex.png" alt="Lumeex Screenshot" />
</div>
**Lumeex** - Yet another minimalist very light photo gallery with a static site generator.
**Lumeex** — A minimalist, lightweight photo gallery static site generator.
Lumeex is a static site generator that builds a minimalist photo gallery. The project was born from the need to create a gallery focused more on the artworks than the author, while allowing users to organize works using tags and share filtered views. In this spirit, each page load displays the photos in random order, allowing users to discover new content they might not have seen before.
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 comes with two themes: one modern, the other more minimalistic, both designed to keep the focus on the artworks:
- Modern 👉 [check the demo](https://modern.djeex.fr)
- Typewriter 👉 [check the demo](https://typewriter.djeex.fr)
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.
> [!NOTE]
> _This GitHub repository is a mirror of https://git.djeex.fr/Djeex/lumeex. You’ll find the complete package, history, and release notes there. An LLM is used for bug checking._
## 📌 Table of Contents
- [Features](#features)
- [Python Installation](#python-installation)
- [Configuration](#configuration)
- [✨ Features](#-features)
- [🐍 Python Installation](#-python-installation)
- [⚙️ Configuration](#-configuration)
## Features
**Gallery (Static Website)**
- Photos displayed in a random order on each page load.
- Tag-based filtering (with the ability to combine multiple tags).
- Shareable URLs with active tag filters.
- A photo carousel on the landing page.
- A legal notice page.
- Two visual themes (easily customizable):
- Modern 👉 [demo](https://modern.djeex.fr)
- Typewriter 👉 [demo](https://typewriter.djeex.fr)
- Supports Google Fonts and local fonts.
## ✨ Features
**No-Code Builder Based on YAML Files**
- YAML files to configure site information, SEO, colors, fonts, etc.—no code needed
- YAML files to reference and tag photos—no code needed.
- *(Optional)* Automatically add photos to the reference file.
### Gallery (Static Website)
**Simple Build Process**
- Compiles from YAML config files (theme selection, template building, fonts, colors, etc.).
- Automatically converts the favicon to all required formats.
- Automatically resize social thumbnail
- *(Optional)* Automatically resizes photos to a max width of 1140px.
- *(Optional)* Converts images to WebP for better performance.
- Outputs a fully generated static website, ready to be copied to any web server.
- 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
## Python Installation
### No-Code Builder (YAML Based)
Instructions to run the Python scripts directly.
- 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
**Requirements**
### Simple Build Process
- Python 3.11 or higher
- PyYAML
- Pillow
- 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
**Installation**
## 🐍 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
@ -66,8 +74,8 @@ source .venv/bin/activate
pip install -r requirements.txt
```
You're ready to go!
You are now ready to use Lumeex!
## Configuration
For detailed documentation about configuration options, customization and demo, visit https://lumeex.djeex.fr
### ⚙️ Configuration
For comprehensive documentation on configuration options, customization, and demos, please visit:
https://lumeex.djeex.fr