f3a35c5a2b
Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja> git-svn-id: file:///srv/svn/repo/aya/trunk@84 cec141ff-132a-4243-88a5-ce187bd62f94
88 lines
1.6 KiB
Groff
88 lines
1.6 KiB
Groff
.Dd $Mdocdate$
|
|
.Dt AYA 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm aya
|
|
.Nd The fastest static site generator
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op build
|
|
.Op clean
|
|
.Op serve
|
|
.Op var Ar file Ar variable
|
|
.Op watch
|
|
.Sh DESCRIPTION
|
|
Does it need one?
|
|
.Sh FEATURES
|
|
.Bl -tag -width 11n -compact
|
|
.It Zero configuration (no configuration file needed)
|
|
.It Cross-platform
|
|
.It Highly extensible
|
|
.It Works well for blogs and generic static websites (landing pages etc)
|
|
.It Easy to learn
|
|
.It Fast (of course)
|
|
.It Only 4 external dependencies!
|
|
.El
|
|
.Sh USAGE
|
|
.Bl -tag -width 11n -compact
|
|
.It build
|
|
(Re-)build a site
|
|
or a file in particular
|
|
.It clean
|
|
Removes the generated
|
|
site directory
|
|
.It serve
|
|
Serves the .pub
|
|
directory over
|
|
HTTP
|
|
.It var
|
|
Print a list of variables
|
|
defined in a given
|
|
markdown file,
|
|
including empty
|
|
variables.
|
|
.It watch
|
|
(Re-)build a site if
|
|
any file changed.
|
|
.El
|
|
.Sh HISTORY
|
|
.Nm
|
|
was forked from
|
|
.Lk https://git.mills.io/prologic/zs
|
|
due to disgust with how the project
|
|
turned out to be.
|
|
Later on, features from the original
|
|
program were reimplemented and
|
|
it took a different path from both.
|
|
.Sh ENVIRONMENT
|
|
.Bl -tag -width 11n
|
|
.It Ev AYADIR
|
|
Directory where
|
|
extensions, layouts and
|
|
hooks placed in to be used
|
|
by the program
|
|
.It Ev PUBDIR
|
|
Directory where generated files are
|
|
located
|
|
.It Ev AYA_*
|
|
Internal variables regarding a
|
|
Markdown document in question,
|
|
see
|
|
.Dq aya var <file>
|
|
.El
|
|
.Sh EXIT STATUS
|
|
.Ex -std
|
|
.Sh AUTHORS
|
|
.Nm
|
|
is maintained by
|
|
.An Izuru Yakumo
|
|
.Aq Mt yakumo.izuru@chaotic.ninja
|
|
.Pp
|
|
.Nm zs
|
|
was made by
|
|
.An Serge Zaitsev
|
|
.Aq Mt hello@zserge.com
|
|
.Sh BUGS
|
|
If you find any, please report them to
|
|
.Aq Mt aya-dev@chaotic.ninja
|