Mercurial > yakumo_izuru > aya
annotate aya.1 @ 89:744541fee713 draft
Ayaya, why did I do that again?
| author | yakumo.izuru |
|---|---|
| date | Sun, 04 May 2025 02:19:10 +0000 |
| parents | d8c30f64e301 |
| children |
| rev | line source |
|---|---|
| 55 | 1 .Dd $Mdocdate$ |
| 2 .Dt AYA 1 | |
| 3 .Os | |
| 4 .Sh NAME | |
| 5 .Nm aya | |
| 83 | 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 | |
| 55 | 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) | |
| 83 | 24 .It Only 4 external dependencies! |
| 55 | 25 .El |
| 26 .Sh USAGE | |
| 68 | 27 .Bl -tag -width 11n -compact |
|
60
cf7277e42ece
Add serve function, update documentation accordingly
yakumo.izuru
parents:
55
diff
changeset
|
28 .It build |
| 68 | 29 (Re-)build a site |
| 30 or a file in particular | |
| 62 | 31 .It clean |
| 68 | 32 Removes the generated |
| 33 site directory | |
| 69 | 34 .It serve |
| 35 Serves the .pub | |
| 36 directory over | |
| 37 HTTP | |
|
60
cf7277e42ece
Add serve function, update documentation accordingly
yakumo.izuru
parents:
55
diff
changeset
|
38 .It var |
| 68 | 39 Print a list of variables |
| 40 defined in a given | |
| 69 | 41 markdown file, |
| 42 including empty | |
| 43 variables. | |
|
60
cf7277e42ece
Add serve function, update documentation accordingly
yakumo.izuru
parents:
55
diff
changeset
|
44 .It watch |
| 68 | 45 (Re-)build a site if |
| 69 | 46 any file changed. |
| 68 | 47 .El |
|
60
cf7277e42ece
Add serve function, update documentation accordingly
yakumo.izuru
parents:
55
diff
changeset
|
48 .Sh HISTORY |
| 55 | 49 .Nm |
| 83 | 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. | |
| 89 | 54 .Pp |
| 83 | 55 Later on, features from the original |
| 56 program were reimplemented and | |
| 57 it took a different path from both. | |
| 58 .Sh ENVIRONMENT | |
| 59 .Bl -tag -width 11n | |
| 60 .It Ev AYADIR | |
| 61 Directory where | |
| 62 extensions, layouts and | |
| 63 hooks placed in to be used | |
| 64 by the program | |
| 65 .It Ev PUBDIR | |
| 66 Directory where generated files are | |
| 67 located | |
| 68 .It Ev AYA_* | |
| 69 Internal variables regarding a | |
| 70 Markdown document in question, | |
| 71 see | |
| 72 .Dq aya var <file> | |
| 73 .El | |
| 74 .Sh EXIT STATUS | |
| 75 .Ex -std | |
| 55 | 76 .Sh AUTHORS |
| 77 .Nm | |
| 68 | 78 is maintained by |
| 79 .An Izuru Yakumo | |
| 89 | 80 .Aq Mt eternal-servant@yakumo.dev |
| 83 | 81 .Pp |
| 82 .Nm zs | |
| 83 was made by | |
| 84 .An Serge Zaitsev | |
| 85 .Aq Mt hello@zserge.com | |
| 69 | 86 .Sh BUGS |
| 89 | 87 Always seems to generate HTML5 no matter what |
| 88 DOCTYPE you place in the layout file. | |
| 89 .Pp | |
| 90 This has to be a problem with | |
| 91 .Nm blackfriday |