aboutsummaryrefslogtreecommitdiffstats
path: root/man/ssg.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/ssg.1')
-rw-r--r--man/ssg.1104
1 files changed, 57 insertions, 47 deletions
diff --git a/man/ssg.1 b/man/ssg.1
index 837fbf7..57666bd 100644
--- a/man/ssg.1
+++ b/man/ssg.1
@@ -1,50 +1,60 @@
-.TH SSG 1 "2026-01-01" "ssg" "General Commands Manual"
-.SH NAME
-ssg \- a tiny static site generator
-.SH SYNOPSIS
-.B ssg
-.I command
-.RI [ options ]
-.SH DESCRIPTION
-.B ssg
-is a minimal static site generator that reads JSON data files and renders
-Go templates to produce static HTML. Static assets are copied unchanged
-to the output directory.
-.SH COMMANDS
-.TP
-.BR ssg-build (1)
+.Dd January 2, 2026
+.Dt SSG 1
+.Os
+.Sh NAME
+.Nm ssg
+.Nd a tiny static site generator
+.Sh SYNOPSIS
+.Nm ssg
+.Op Fl h | -help
+.Ar <command>
+.Ar [<args>]
+.Sh DESCRIPTION
+.Nm
+is a tiny static site generator that can render Go templates to produce static
+HTML. If any JSON data files are provided, they are automatically accessible
+within the Go templates. Static assets are copied verbatim to the build output
+directory.
+.Sh OPTIONS
+.Bl -tag -width Ds
+.It Fl h , Fl -help
+Print brief usage information.
+.El
+.Sh COMMANDS
+.Bl -tag -width Ds
+.It Xr ssg-build 1
Build the site.
-.TP
-.BR ssg-serve (1)
-Start a local HTTP server.
-.TP
-.BR ssg-init (1)
+.It Xr ssg-help 1
+Show the manual for a command.
+.It Xr ssg-init 1
Initialize a new site.
-.TP
-.BR ssg-version (1)
+.It Xr ssg-serve 1
+Start a local HTTP server serving the output directory.
+.It Xr ssg-version 1
Print the version.
-.TP
-.BR ssg-help (1)
-Show help for a command.
-.SH FILES
-.TP
-.I data/
-JSON data files. Each file becomes a template variable.
-.TP
-.I templates/
-HTML template files.
-.TP
-.I static/
-Static files copied unchanged.
-.TP
-.I dist/
-Default output directory.
-.SH SEE ALSO
-.BR ssg-build (1),
-.BR ssg-serve (1),
-.BR ssg-init (1),
-.BR ssg-version (1),
-.BR ssg-help (1),
-.BR ssg-templates (5)
-.SH AUTHOR
-Eugene Triguba <hello@eugenetriguba.com>
+.El
+.Sh FILES
+.Bl -tag -width Ds
+.It Pa data/
+Data files to make available to the HTML templates.
+.It Pa templates/
+HTML template files using the Go templating language. See
+.Xr ssg-templates 5
+for details.
+.It Pa static/
+Any files that should be copied to the output directory when the site is built
+e.g. CSS, images, etc.
+.It Pa dist/
+Default output directory that contains the static files verbatim and the
+rendered HTML files. See
+.Xr ssg-build 1
+for details.
+.El
+.Sh EXIT STATUS
+.Nm
+exits 0 on success, and >0 if an error occurs.
+.Sh AUTHOR
+.Nm
+was written and is maintained by
+.An Eugene Triguba ,
+.Mt hello@eugenetriguba.com .