/[aya]/aya.1
ViewVC logotype

Annotation of /aya.1

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.1 - (hide annotations)
Mon Sep 30 00:42:05 2024 UTC (6 weeks, 4 days ago) by yakumo_izuru
Branch: MAIN
CVS Tags: HEAD
Mirrored from https://git.chaotic.ninja/git/yakumo_izuru/aya

1 yakumo_izuru 1.1 .Dd $Mdocdate$
2     .Dt AYA 1
3     .Os
4     .Sh NAME
5     .Nm aya
6     .Nd The fastest static site generator
7     .Sh SYNOPSIS
8     .Nm
9     .Op build
10     .Op clean
11     .Op serve
12     .Op var Ar file Ar variable
13     .Op watch
14     .Sh DESCRIPTION
15     Does it need one?
16     .Sh FEATURES
17     .Bl -tag -width 11n -compact
18     .It Zero configuration (no configuration file needed)
19     .It Cross-platform
20     .It Highly extensible
21     .It Works well for blogs and generic static websites (landing pages etc)
22     .It Easy to learn
23     .It Fast (of course)
24     .It Only 4 external dependencies!
25     .El
26     .Sh USAGE
27     .Bl -tag -width 11n -compact
28     .It build
29     (Re-)build a site
30     or a file in particular
31     .It clean
32     Removes the generated
33     site directory
34     .It serve
35     Serves the .pub
36     directory over
37     HTTP
38     .It var
39     Print a list of variables
40     defined in a given
41     markdown file,
42     including empty
43     variables.
44     .It watch
45     (Re-)build a site if
46     any file changed.
47     .El
48     .Sh HISTORY
49     .Nm
50     was forked from
51     .Lk https://git.mills.io/prologic/zs
52     due to disgust with how the project
53     turned out to be.
54     Later on, features from the original
55     program were reimplemented and
56     it took a different path from both.
57     .Sh ENVIRONMENT
58     .Bl -tag -width 11n
59     .It Ev AYADIR
60     Directory where
61     extensions, layouts and
62     hooks placed in to be used
63     by the program
64     .It Ev PUBDIR
65     Directory where generated files are
66     located
67     .It Ev AYA_*
68     Internal variables regarding a
69     Markdown document in question,
70     see
71     .Dq aya var <file>
72     .El
73     .Sh EXIT STATUS
74     .Ex -std
75     .Sh AUTHORS
76     .Nm
77     is maintained by
78     .An Izuru Yakumo
79     .Aq Mt yakumo.izuru@chaotic.ninja
80     .Pp
81     .Nm zs
82     was made by
83     .An Serge Zaitsev
84     .Aq Mt hello@zserge.com
85     .Sh BUGS
86     If you find any, please report them to
87     .Aq Mt aya-dev@chaotic.ninja

nishi@chaotic.ninja
ViewVC Help
Powered by ViewVC 1.3.0-dev