comparison zs.1 @ 53:be0a08e4a0f6 draft

Add manual page for zs
author novaburst
date Fri, 07 Jan 2022 23:20:40 +0000
parents
children 4d411cdd68c1
comparison
equal deleted inserted replaced
52:befb74a09424 53:be0a08e4a0f6
1 .Dd January 7, 2022
2 .Dt ZS 1
3 .Os
4 .Sh NAME
5 .Nm zs
6 .Nd Absolutely minimal static site generator written in Go.
7 .Sh DESCRIPTION
8 .Nm
9 is an extremely minimal static site generator written in Go.
10 .Pp
11 It's inspired by
12 .Em zas
13 generator, but is even more minimal.
14 .Pp
15 The name stands for 'zen static'
16 .Sh FEATURES
17 .Li Zero configuration (no configuration file needed)
18 .Pp
19 .Li Cross-platform
20 .Pp
21 .Li Highly extensible
22 .Pp
23 .Li Works well for blogs and generic static websites (landing pages etc)
24 .Pp
25 .Li Easy to learn
26 .Pp
27 .Li Fast
28 .Sh USAGE
29 .Ss (Re-)build your site.
30 .Nm
31 .Cm build
32 .Ss (Re-)build one file and prints resulting content to standard output.
33 .Nm
34 .Cm build
35 .Ar <file>
36 .Ss (Re-)build your site every time you modify any file.
37 .Nm
38 .Cm watch
39 .Ss Print a list of variables defined in the header of a given markdown file.
40 .Nm
41 .Cm var
42 .Ar <file>
43 .Ar <var1> <var2> ...
44 .Sh AUTHORS
45 .Nm
46 was made by James Mills
47 .Aq Lk https://prologic.shortcircuit.net.au/
48 .Pp
49 This manual page was written by Nova
50 .Aq Lk https://tilde.cafe/~novaburst