https://github.com/cliffordwebhole/webholeink
WebholeInk is a minimalist, open-source blogging engine built by and for developers who care about security, stability, and owning their words long-term.
https://github.com/cliffordwebhole/webholeink
blogging cms developer-tools markdown markdown-language minimalist open-source self-hosted
Last synced: 6 months ago
JSON representation
WebholeInk is a minimalist, open-source blogging engine built by and for developers who care about security, stability, and owning their words long-term.
- Host: GitHub
- URL: https://github.com/cliffordwebhole/webholeink
- Owner: cliffordwebhole
- License: mit
- Created: 2025-12-31T15:40:25.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-01-12T16:16:14.000Z (6 months ago)
- Last Synced: 2026-01-13T21:09:25.172Z (6 months ago)
- Topics: blogging, cms, developer-tools, markdown, markdown-language, minimalist, open-source, self-hosted
- Language: PHP
- Homepage: https://webholeink.com
- Size: 4.62 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE. Md
- Security: docs/SECURITY.md
- Roadmap: docs/ROADMAP.md
Awesome Lists containing this project
README
# WebholeInk
**WebholeInk** is a minimal, developer-first publishing engine.
No plugins.
No databases.
No magic.
Just files, clear contracts, and full control.
---
## 🚀 Status
**v0.1.0 — Core Stable**
The core engine is complete and locked.
This release establishes:
- Routing
- Handlers
- Content resolution
- Theming
- Navigation
- Markdown rendering
- View and layout contracts
No new features will be added to core without a version bump.
## v0.1.2 — Platform Hardening & Documentation
This release builds **around** the locked core without modifying it.
v0.1.2 focuses on operational stability, discoverability, and long-term maintainability rather than new features.
This release adds:
- Full documentation system (`/docs`) rendered from Markdown
- Canonical URLs, Open Graph, and Twitter metadata
- RSS (`feed.xml`) and JSON Feed (`feed.json`)
- Sitemap generation (`sitemap.xml`)
- Robots.txt for crawler control
- HTTP security headers
- HTTP caching with ETag and Last-Modified support
- Draft-aware content exclusion
- CLI tooling for content creation
- Deployment and operations documentation
No changes were made to:
- Core routing logic
- Content resolution rules
- View or layout contracts
- Markdown parsing behavior
The core remains **stable, locked, and boring**.
v0.1.2 establishes WebholeInk as a **production-ready publishing platform** while preserving the integrity of the core engine.
---
## 🎯 Philosophy
WebholeInk exists to solve one problem well:
> **Publish content without surrendering control.**
Everything is explicit.
Everything is readable.
Everything is owned by the developer.
There is no admin panel.
There is no plugin system.
There is no database requirement.
If it’s not in the filesystem, it doesn’t exist.
---
## 🧱 Architecture Overview
public/ → HTTP entry point (only public files) app/ → Core engine (locked) content/ → Markdown content (pages, posts) config/ → Explicit configuration docs/ → Contracts & documentation
Core responsibilities are split cleanly:
- **Router** → maps paths to handlers
- **Handlers** → decide *what* to render
- **PageResolver** → resolves content files
- **View / PageView** → renders templates safely
- **Layout** → wraps content with theme chrome
- **Themes** → presentation only (no logic)
---
## 📝 Content Model
Content is file-based and predictable.
content/ └── pages/ ├── home.md ├── about.md ├── philosophy.md └── page.md
- URLs map directly to filenames
- `/about` → `content/pages/about.md`
- Markdown is parsed at runtime
- No front-matter required (by design)
---
## 🎨 Theming
Themes are PHP templates, not magic.
app/themes/default/ ├── layout.php ├── home.php ├── page.php ├── navigation.php ├── footer.php └── assets/
- Themes do **presentation only**
- Logic lives in handlers and core
- Assets are served from `public/themes/`
---
### 🎨 Author-Controlled Themes
WebholeInk supports multiple visual themes per site.
- Themes are selected by the publisher
- Visitors cannot toggle themes
- Themes are versioned and cache-safe
- No JavaScript required
This ensures predictable rendering and long-term maintainability.
---
## 📚 Contracts (Locked)
Core behavior is defined by explicit contracts:
- `CORE.md` – system architecture
- `ROUTES.md` – routing rules
- `HANDLERS.md` – handler contract
- `CONTENT.md` – content resolution rules
- `VIEW.md` – view rendering rules
- `NAVIGATION.md` – navigation behavior
- `THEMES.md` – theming constraints
If it’s not documented, it’s not supported.
---
## 🔒 Stability Guarantee
This release is **core-stable**.
That means:
- No breaking changes without a version bump
- No silent behavior changes
- No scope creep
Future work will build **on top of** this foundation, not rewrite it.
---
## 🛠 Requirements
- PHP 8.2+
- Nginx or compatible web server
- No database
- No extensions beyond standard PHP
---
## 📦 Backup & Recovery
WebholeInk is intentionally easy to back up:
- Filesystem snapshot
- Git repository
- No state hidden elsewhere
If you can copy a directory, you can restore the site.
---
## 🧭 Roadmap
**v0.2.0 (Planned)**
- Collections / posts
- Metadata (optional, explicit)
- Pagination helpers
Core principles will not change.
---
## 🐝 Built By
Clifford Webhole
---
**WebholeInk**
_Developer-first publishing, without compromise._
## Documentation
- [Core Architecture](docs/CORE.md)
- [Routing Rules](docs/ROUTER.md)
- [Handler Contract](docs/HANDLERS.md)
- [Content Rules](docs/CONTENT.md)
- [Themes Contract](docs/THEMES.md)
- [View Contract](docs/VIEW.md)
- [Navigation Contract](docs/NAVIGATION.md)
- [Project Status](docs/STATUS.md)
- See [Installation](./INSTALL.md) for first-time setup.
## 📄 License
WebholeInk is open-source software licensed under the MIT License.