aboutsummaryrefslogtreecommitdiffstats
path: root/man/ssg.1
blob: 57666bd967e9df81a552036eae448fd77a78d59d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
.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.
.It Xr ssg-help 1
Show the manual for a command.
.It Xr ssg-init 1
Initialize a new site.
.It Xr ssg-serve 1
Start a local HTTP server serving the output directory.
.It Xr ssg-version 1
Print the version.
.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 .