annotate aya.1 @ 75:84270933ac8d draft

The Emperor (IV) * `aya help` is provided by aya.PrintUsage() now Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>
author yakumo.izuru
date Mon, 04 Dec 2023 02:21:03 +0000
parents 03019bbf2e0e
children d8c30f64e301
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
68
4b79810863f6 Ready to release 0.6.0
yakumo.izuru
parents: 67
diff changeset
19 .Bl -tag -width 11n -compact
60
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
20 .It build
68
4b79810863f6 Ready to release 0.6.0
yakumo.izuru
parents: 67
diff changeset
21 (Re-)build a site
4b79810863f6 Ready to release 0.6.0
yakumo.izuru
parents: 67
diff changeset
22 or a file in particular
62
2d9f9b32ae1f Add a clean subcommand
yakumo.izuru
parents: 60
diff changeset
23 .It clean
68
4b79810863f6 Ready to release 0.6.0
yakumo.izuru
parents: 67
diff changeset
24 Removes the generated
4b79810863f6 Ready to release 0.6.0
yakumo.izuru
parents: 67
diff changeset
25 site directory
69
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
26 .It serve
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
27 Serves the .pub
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
28 directory over
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
29 HTTP
60
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
30 .It var
68
4b79810863f6 Ready to release 0.6.0
yakumo.izuru
parents: 67
diff changeset
31 Print a list of variables
4b79810863f6 Ready to release 0.6.0
yakumo.izuru
parents: 67
diff changeset
32 defined in a given
69
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
33 markdown file,
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
34 including empty
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
35 variables.
60
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
36 .It watch
68
4b79810863f6 Ready to release 0.6.0
yakumo.izuru
parents: 67
diff changeset
37 (Re-)build a site if
69
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
38 any file changed.
68
4b79810863f6 Ready to release 0.6.0
yakumo.izuru
parents: 67
diff changeset
39 .El
60
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
40 .Sh HISTORY
55
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
41 .Nm
69
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
42 was originally forked from
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
43 prologic/zs by Izuru out of disgust
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
44 with the latest revision, so he used an
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
45 earlier commit as a base, and then
60
cf7277e42ece Add serve function, update documentation accordingly
yakumo.izuru
parents: 55
diff changeset
46 eventually reimplemented older features from
69
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
47 the original project.
55
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
48 .Sh AUTHORS
c6785950280e The fastest, period.
yakumo.izuru
parents:
diff changeset
49 .Nm
68
4b79810863f6 Ready to release 0.6.0
yakumo.izuru
parents: 67
diff changeset
50 is maintained by
4b79810863f6 Ready to release 0.6.0
yakumo.izuru
parents: 67
diff changeset
51 .An Izuru Yakumo
67
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents: 62
diff changeset
52 .Aq Lk https://geidontei.chaotic.ninja/usr/yakumo_izuru/
69
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
53 .Sh BUGS
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
54 Report them to this mailing list
03019bbf2e0e Fix a bug that I caused
yakumo.izuru
parents: 68
diff changeset
55 .Mt devel@chaotic.ninja