Skip to main content

Quick Start

A minimal structpages app with two pages and Templ-rendered HTML. Run it in under five minutes.

1. Create the project​

mkdir hello-structpages && cd hello-structpages
go mod init hello-structpages
go get github.com/jackielii/structpages
go get github.com/a-h/templ

Pin the templ CLI as a tool dep so collaborators get the right version:

go get -tool github.com/a-h/templ/cmd/templ@latest

2. Define your pages​

Create pages.templ:

package main

type home struct{}

templ (home) Page() {
    <html>
        <body>
            <h1>Hello, structpages!</h1>
            <p><a href="/about">About</a></p>
        </body>
    </html>
}

type about struct{}

templ (about) Page() {
    <html>
        <body>
            <h1>About</h1>
            <p><a href="/">Home</a></p>
        </body>
    </html>
}

type pages struct {
    home  `route:"/ Home"`
    about `route:"/about About"`
}

3. Wire up main.go​

package main

import (
    "log"
    "net/http"

    "github.com/jackielii/structpages"
)

func main() {
    mux := http.NewServeMux()
    if _, err := structpages.Mount(mux, pages{}, "/", "Site"); err != nil {
        log.Fatal(err)
    }
    log.Println("Listening on :8080")
    if err := http.ListenAndServe(":8080", mux); err != nil {
        log.Fatal(err)
    }
}

4. Generate Templ code and run​

go tool templ generate -include-version=false
go run .

Open http://localhost:8080. You should see "Hello, structpages!" and a link to /about.

What just happened​

  • pages is a struct with two embedded fields, each tagged with a route. Embedding means promoted methods — but the dispatcher skips promoted methods, so the Page() defined on each inner type is the one that runs.
  • Mount(mux, pages{}, "/", "Site") walks the struct, registers each route on mux, and treats the outer pages struct as a layout with no Page() of its own.
  • Each request is dispatched to the matching leaf struct, which renders its Page() (a Templ component) into the response.

Next steps​

  • Routing for the full tag syntax (HTTP methods, path params, titles).
  • Templ Patterns for shared layouts and the Props pattern.
  • HTMX Integration for partial rendering driven by hx-target.
  • Examples for full working apps in examples/ you can clone.