diff options
Diffstat (limited to 'man/ssg-build.1')
| -rw-r--r-- | man/ssg-build.1 | 99 |
1 files changed, 48 insertions, 51 deletions
diff --git a/man/ssg-build.1 b/man/ssg-build.1 index 231d1ae..83e09ee 100644 --- a/man/ssg-build.1 +++ b/man/ssg-build.1 @@ -1,59 +1,56 @@ -.TH SSG-BUILD 1 "2026-01-01" "ssg" "General Commands Manual" -.SH NAME -ssg-build \- build the site -.SH SYNOPSIS -.B ssg build -.RI [ options ] -.SH DESCRIPTION -Build the static site by rendering templates with data and copying static files. -.PP -Templates are processed using Go's html/template package. See -.BR ssg-templates (5) +.Dd January 2, 2026 +.Dt SSG-BUILD 1 +.Os +.Sh NAME +.Nm ssg-build +.Nd build the site +.Sh SYNOPSIS +.Nm ssg build +.Op Fl h | -help +.Op Fl d | -data Ar dir +.Op Fl t | -templates Ar dir +.Op Fl s | -static Ar dir +.Op Fl o | -out Ar dir +.Op Fl q | -quiet +.Sh DESCRIPTION +.Nm +builds the static site by rendering HTML templates with the provided data into +the output directory and copying static files to the output directory. +.Pp +Templates are processed using Go's +.Lk https://pkg.go.dev/html/template html/template +package. See +.Xr ssg-templates 5 for template syntax and available functions. -.SH OPTIONS -.TP -.BI \-data " dir" +.Sh OPTIONS +.Bl -tag -width Ds +.It Fl h , Fl -help +Print brief usage information. +.It Fl d Ar dir , Fl -data Ar dir Data directory containing JSON files. Default: data -.TP -.BI \-templates " dir" +.It Fl t Ar dir , Fl -templates Ar dir Templates directory containing HTML files. Default: templates -.TP -.BI \-static " dir" +.It Fl s Ar dir , Fl -static Ar dir Static files directory. Default: static -.TP -.BI \-out " dir" +.It Fl o Ar dir , Fl -out Ar dir Output directory. Default: dist -.TP -.B \-q +.It Fl q , Fl -quiet Quiet mode. Only show errors. -.SH EXAMPLES +.El +.Sh EXIT STATUS +.Nm +exits 0 on success, and >0 if an error occurs. +.Sh EXAMPLES Build a site: -.PP -.RS -.nf -$ ssg build -.fi -.RE -.PP -Build to a custom output directory: -.PP -.RS -.nf -$ ssg build -out=public -.fi -.RE -.PP +.Dl $ ssg build +.Pp Build with custom directories: -.PP -.RS -.nf -$ ssg build -data=content -templates=layouts -out=public -.fi -.RE -.SH SEE ALSO -.BR ssg-templates (5), -.BR ssg-serve (1) -.SH SSG -Part of the -.BR ssg (1) -suite. +.Dl $ ssg build --static assets --data content --templates layouts --out public +.Pp +Build with regular output silenced: +.Dl $ ssg build --quiet +.Pp +.Sh SEE ALSO +.Xr ssg 1 , +.Xr ssg-serve 1 , +.Xr ssg-templates 5 |