README
¶
go-template-static
A Go library that extracts CSS and JS from Go HTML templates into standalone static files.
Keep your styles and scripts colocated with your templates during development. At startup, Parse pulls them out into .css/.js files and injects <link>/<script> tags into <head>.
Install
go get github.com/samueldcorbin/go-template-static@v0.2.0
Usage
Define your CSS and JS with static-css- or static-js- prefixed names:
{{define "static-css-main"}}
body { margin: 0; }
h1 { color: navy; }
{{end}}
{{define "static-js-app"}}
console.log("ready");
{{end}}
<html>
<head></head>
<body>
<h1>Hello</h1>
</body>
</html>
Then call Parse at startup:
package main
import (
"html/template"
"net/http"
templatestatic "github.com/samueldcorbin/go-template-static"
)
func main() {
t := template.Must(template.ParseGlob("templates/*.html"))
rt, err := templatestatic.Parse(t, nil, "./static", "/static")
if err != nil {
panic(err)
}
// Serve the extracted static files.
http.Handle("/static/", http.StripPrefix("/static/", http.FileServer(http.Dir("./static"))))
// Render using rt — <link>/<script> tags are injected automatically.
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
rt.ExecuteTemplate(w, "page.html", nil)
})
http.ListenAndServe(":8080", nil)
}
This writes ./static/main.css and ./static/app.js, and renders the page as:
<html>
<head>
<link rel="stylesheet" href="/static/main.css">
<script src="/static/app.js"></script>
</head>
<body>
<h1>Hello</h1>
</body>
</html>
The <link> and <script> tags are injected automatically before </head> (CSS first, then JS). If you need to control placement, use an explicit {{template "static-css-main"}} call and the tag will appear there instead.
The original template t is never modified.
API
func Parse(t *template.Template, data any, outputDir, urlPrefix string) (*template.Template, error)
- t — the source template (not modified)
- data — passed to each static definition during rendering (use for template variables in your CSS/JS)
- outputDir — directory to write static files into (created if needed)
- urlPrefix — URL path prefix for generated
<link>/<script>tags - Returns a new template ready for rendering
Files are only written when content changes, preserving mtime for stable caching.
Editor Support
For syntax highlighting of CSS/JS inside static definitions, install the samueldcorbin.go-template-static-syntax VS Code extension.
License
MIT
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Parse ¶
Parse clones t, extracts templates named static-css-* and static-js-*, writes them as files to outputDir, and returns a new template with <link>/<script> tags injected before </head> (CSS first, then JS).
If a static definition has an explicit {{template "static-css-*"}} call in the template tree, the tag appears there instead of being auto-injected.
The original template t is not modified.
Types ¶
This section is empty.
Source Files