zs/contrib/zs.1

51 lines
1.0 KiB
Groff

.Dd January 7, 2022
.Dt ZS 1
.Os
.Sh NAME
.Nm zs
.Nd Absolutely minimal static site generator written in Go.
.Sh DESCRIPTION
.Nm
is an extremely minimal static site generator written in Go.
.Pp
It's inspired by
.Em zas
generator, but is even more minimal.
.Pp
The name stands for 'zen static'
.Sh FEATURES
.Li Zero configuration (no configuration file needed)
.Pp
.Li Cross-platform
.Pp
.Li Highly extensible
.Pp
.Li Works well for blogs and generic static websites (landing pages etc)
.Pp
.Li Easy to learn
.Pp
.Li Fast
.Sh USAGE
.Ss (Re-)build your site.
.Nm
.Cm build
.Ss (Re-)build one file and prints resulting content to standard output.
.Nm
.Cm build
.Ar <file>
.Ss (Re-)build your site every time you modify any file.
.Nm
.Cm watch
.Ss Print a list of variables defined in the header of a given markdown file.
.Nm
.Cm var
.Ar <file>
.Ar <var1> <var2> ...
.Sh AUTHORS
.Nm
is maintained by James Mills
.Aq Lk https://prologic.shortcircuit.net.au/
.Pp
This manual page was written by Nova
.Aq Lk https://tilde.cafe/~novaburst