SimplyPages documentation
SimplyPages builds server-rendered HTML in Java. Start with the task you want to accomplish. This documentation follows Diátaxis: learning through tutorials, solving tasks with how-to guides, looking up reference facts, and understanding design through explanation.
| Your need | Start here |
|---|---|
| Set up a checkout and follow the learning path | Getting started |
| Learn by running a small example | Tutorials |
| Build a blog, forum, editable page, chat panel, dashboard, or form | How-to guides |
| Look up APIs, defaults, assets, and build requirements | Reference |
| Understand rendering, reuse, and security boundaries | Explanation |
| Browse every existing guide by topic | Complete index |
Start here
- Getting started: clone/local build and host requirements.
- First page, then dynamic page:
two complete Java programs with a local
1.2.1dependency. - Serve full pages and HTMX fragments: add a real HTTP host, assets, and correct response targets.
- Choose a task below. The guides extend your existing application; they are not six new tutorial applications or automatically installed sandbox endpoints.
Build something useful
- Markdown blog: directory-backed articles and pagination.
- Forum browser: topics and paginated comments.
- User-editable pages: owner-authorized modal editing.
- Chat panel: session-local messages with working HTMX polling.
- Dashboard: metrics, table, and responsive cards.
- Server-validated forms: errors, retained input, and confirmation.
SimplyPages supplies rendering and UI composition. Your application owns identity, authorization, CSRF verification, persistence, and transport. Each task guide states its prerequisites and whether its example state is local or nondurable.
Requirements and version
The checkout builds io.mindspice:simplypages:1.2.1. Use JDK 21 or later to build and run it.
Install the library locally with ./mvnw -pl simplypages install. GitHub release v1.2.1
provides the library artifacts; they are not published to Maven Central. The library and
Spring Boot 4.1.1 site both target Java 21 bytecode.
This is a controlled beta. Read the known issues and support boundaries for open defects, the local Chromium baseline, and current site limitations before adoption.
Read online or locally
These Markdown pages work in repository viewers and in the site's /docs browser.
Run ./build-site.sh and then java -jar site/target/simplypages-site.jar; open
local documentation, the demo catalog,
or the Java API entry, which links to native generated Javadocs.
The local build skips tests and verifies the packaged Markdown and generated Javadoc inventories
and bytes in the site JAR, so those resources do not require a source checkout.
Existing topic-based pages remain available at their original paths. The four sections above provide a focused reading path through those pages and the new runnable examples. The historical 1.0.1 migration notes remain available; they do not replace the current contracts.