| Payload |
{
"markdown": "# About Soffio\n**Soffio** is a calm, self-hosted publishing system for technical writers who want static output, admin convenience, and operational control.\n\n## Product Position\n\nSoffio is not a general-purpose CMS. It is for people who want to write, publish, automate, and self-host without surrendering control. It is for everyone.\n\nIt favors:\n\n- **Static output over runtime magic**: public pages are rendered deliberately and can be served predictably.\n- **Boring reliability over plugin sprawl**: the core publishing path stays small, auditable, and operationally plain.\n- **Explicit workflows over hidden automation**: admin actions, API calls, CLI automation, and render jobs are visible parts of the publishing flow.\n\n## What It Provides\n\n- **Static public output**: rendered posts and pages for fast, cacheable delivery.\n- **Focused admin console**: writing, editing, organizing, publishing, settings, uploads, jobs, audit, and API keys.\n- **Headless API and CLI**: automation-friendly endpoints with scoped API keys and a command-line client.\n- **Server-driven interaction**: Datastar + SSE workflows without a client-side JavaScript application.\n- **Technical writing support**: Markdown, syntax highlighting, KaTeX math, and Mermaid diagrams.\n\n## Architecture\n\nSoffio follows a clean, layered architecture:\n\n- **Public Site**: statically rendered pages with optional server-driven interactive widgets for readers.\n- **Admin Console**: a dedicated interface for writing, editing, organizing, and publishing content.\n- **Headless API**: RESTful endpoints for automation, integrations, and the command-line tool.\n\n## For Operators and Developers\n\nSoffio is open source under the BSD-2-Clause license. The codebase enforces a strict Domain/Application/Infrastructure layering model, making it easy to understand, extend, and contribute.\n\n**Technology Stack:**\n- Rust 2024 Edition\n- Axum 0.8 (HTTP framework)\n- PostgreSQL with SQLx (Database)\n- Askama (Templating)\n- Comrak, KaTeX, Syntect (Content rendering)\n- Apalis (Background jobs)\n\n## Try It Out\n\n- **Demo Site:** [soffio.xfyyzy.xyz](https://soffio.xfyyzy.xyz)\n- **Demo Admin:** [admin.soffio.xfyyzy.xyz](https://admin.soffio.xfyyzy.xyz)\n- **GitHub:** [github.com/xfyyzy/soffio](https://github.com/xfyyzy/soffio)\n\nThe demo database resets every hour, so feel free to experiment!\n\n---\n\n**Author:** [xfyyzy](https://xfyyzy.xyz)\n\n---",
"slug": "about"
}
|