annotate zs.1 @ 54:4d411cdd68c1 draft

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