Documentation Index
This page is the table of contents for all framework documentation. New users should follow Getting started: local build, the two runnable tutorials, HTTP serving, then an application task.
Tutorials
How-to guides
- Task overview
- Serve full pages and HTMX fragments
- Build a Markdown blog
- Build a forum browser
- Build user-editable pages
- Add a session-local chat panel with polling
- Build a dashboard
- Handle server-validated form submissions
- Implement an authorized editing flow
- Publish a Markdown directory
- Build, test, and browse the documentation
Explanation
Core reference
- Reference overview
- Rendering API and contracts
- Build requirements and assets
- Beta status, known issues, and support
The original topic-based guides follow. Their URLs remain stable.
Fundamentals
Getting Started
- Getting Started Overview
- Installation and First Static Page
- Dynamic Pages with SlotKey and RenderContext
- Editing System First Implementation
Core
- Components, HtmlTag, and Module Lifecycle
- Layout: Page, Row, Column, Grid
- Template, RenderContext, and SlotKey Reference
- Rendering Pipeline: High and Low Level
- CSS: Defaults, Overrides, and Structure
- Shell Project Structure and Asset Load Chain
- Mobile Rendering Model and Responsive Behavior
Patterns
- Static Page Serving Patterns
- Dynamic Fragment Caching Patterns
- HTMX Endpoint and Swap Patterns
- Editing Workflows: Owner, User, Approval
- Forum Renderer Implementation and Customization
- Chat Helper with SSE and WebSocket Hooks
- Chat Conversation Scoping and Authorization Patterns
- Static Content Helper Markdown Directory Pipeline
Security
Operations
- Performance, Threading, and Cache Lifecycles
- Testing and Troubleshooting Playbook
- Writing Tests for Components and Modules
- Migrating to SimplyPages 1.0.1