annotate aya.1 @ 60:cf7277e42ece draft

Add serve function, update documentation accordingly Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>
author yakumo.izuru
date Fri, 21 Apr 2023 23:06:28 +0000
parents c6785950280e
children 2d9f9b32ae1f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
55
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
1 .Dd $Mdocdate$
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
2 .Dt AYA 1
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
3 .Os
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
4 .Sh NAME
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
5 .Nm aya
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
6 .Nd A really fast static site generator
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
7 .Sh DESCRIPTION
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
8 Does it need one?
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
9 .Sh FEATURES
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
10 .Bl -tag -width 11n -compact
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
11 .It Zero configuration (no configuration file needed)
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
12 .It Cross-platform
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
13 .It Highly extensible
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
14 .It Works well for blogs and generic static websites (landing pages etc)
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
15 .It Easy to learn
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
16 .It Fast (of course)
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
17 .El
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
18 .Sh USAGE
60
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
19 .Bl -tag
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
20 .It build
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
21 (Re-)build a site or a file in particular
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
22 .It serve
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
23 Serve generated site over HTTP
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
24 .It var
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
25 Print a list of variables defined in a given markdown file.
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
26 .It watch
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
27 (Re-)build a site if any file changed
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
28 .Sh HISTORY
55
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
29 .Nm
60
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
30 was originally forked from prologic/zs by Izuru
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
31 out of disgust with the latest revision, so he
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
32 used a earlier commit as a base, and then
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
33 eventually reimplemented older features from
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
34 zserge's original project.
55
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
35 .Sh AUTHORS
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
36 .Nm
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
37 is maintained by Izuru Yakumo
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
38 .Aq Lk https://pub.chaotic.ninja/~yakumo_izuru/