Files
bludit-blowfish/README.md
T
spleenftw bdfb8e74bb Update README to remove social-network icons reference
Removed mention of social-network SVG icons from README.
2026-05-29 17:46:53 +02:00

76 lines
3.2 KiB
Markdown

# Blowdit
A clean, minimal theme for [Bludit](https://www.bludit.com) inspired by the
[Blowfish](https://blowfish.page/) Hugo theme.
![Bludit](https://img.shields.io/badge/Bludit-3.9+-informational) ![License](https://img.shields.io/badge/license-MIT-green)
## Features
- 🎨 **Five color themes** — the navbar button cycles **Light → Dark → Nord → Dracula → Catppuccin**, remembering the visitor's choice (falls back to the OS preference).
- 🧱 **Monochrome base design** — restrained grayscale palette with crisp typography (Inter).
- 👤 **Profile hero** — circular avatar, site title, slogan and social links on the homepage.
- 📚 **Right sidebar** — drop any Bludit sidebar plugin into it (categories, tags, search…).
- 🔀 **Randomized navigation** — the Navigation/Pages plugin list is shuffled on each load.
- ⏱️ **Reading time & dates** shown on the post list and single posts.
- 🔗 **Social icons** in the navbar and hero, using SVG files in `img/` (GitHub, Mastodon, Bluesky, LinkedIn, and more).
- 🏷️ **Tags & categories** rendered as pill badges.
- 📱 Fully responsive, no flash of the wrong theme on load.
## Installation
1. Download or clone this repository into your Bludit `bl-themes` directory:
```
/usr/share/nginx/html/bl-themes/
```
2. In the Bludit admin panel go to **Settings → Themes** and activate **Blowdit**.
3. Add your assets to `blowdit/img/`:
- Your avatar as `spleenftw.jpeg` — used for the homepage profile hero **and** the favicon.
To use a different filename, change it in [php/head.php](php/head.php) (favicon) and
[php/home.php](php/home.php) (`$profileImage`).
## Layout
```
blowdit/
├── index.php Main template
├── metadata.json Theme metadata
├── css/
│ └── style.css Light & dark styles (CSS custom properties)
├── php/
│ ├── head.php <head>, fonts, favicon, anti-FOUC theme script
│ ├── navbar.php Navbar, social SVG icons, theme toggle
│ ├── home.php Profile hero + post listing
│ ├── page.php Single page / post
│ ├── sidebar.php Sidebar plugin container
│ └── footer.php Footer
├── img/ Social SVG icons + avatar (spleenftw.jpeg)
└── languages/ Translations
```
## Themes
Each theme is just a set of CSS custom properties. Light lives in `:root`; the
others override it under `[data-theme="dark"]`, `[data-theme="nord"]`,
`[data-theme="dracula"]` and `[data-theme="catppuccin"]`. The attribute is set on `<html>` before paint (in
`php/head.php`) to avoid a flash, and the navbar button cycles through them,
persisting the choice to `localStorage`.
To tweak a palette or add your own theme, edit/duplicate the variable blocks at
the top of [css/style.css](css/style.css) and add the theme name to the
`THEMES` array in the toggle script in [index.php](index.php).
## Randomized navigation
If the **Navigation** (or **Pages**) plugin is in the sidebar, its list is
shuffled on every page load by a small script in [index.php](index.php). The
plugin's output is wrapped in `.js-random-nav`; if your plugin uses a different
CSS class, adjust the detection in `index.php` accordingly.
## License
[MIT](LICENSE)