comparison README.md @ 80:ab4829ba7a8a draft

Update README Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>
author yakumo.izuru
date Tue, 12 Dec 2023 14:16:01 +0000
parents 7b122b71fcfa
children d8c30f64e301
comparison
equal deleted inserted replaced
79:7b122b71fcfa 80:ab4829ba7a8a
52 subdiretory. 52 subdiretory.
53 53
54 Everything the extensions prints to [stdout](https://man.freebsd.org/cgi/man.cgi?fd) becomes the value of the 54 Everything the extensions prints to [stdout](https://man.freebsd.org/cgi/man.cgi?fd) becomes the value of the
55 placeholder. 55 placeholder.
56 56
57 Every variable from the content header will be passed via environment variables like `title` becomes `$AYA\_TITLE` and so on. 57 Every variable from the content header will be passed via environment variables like `title` becomes `$AYA_TITLE` and so on.
58 There are some special variables: 58 There are some special variables:
59 59
60 * `$AYA` - a path to the `aya` executable 60 * `$AYA` - a path to the `aya` executable
61 * `$AYA\_OUTDIR` - a path to the directory with generated files 61 * `$AYA_OUTDIR` - a path to the directory with generated files
62 * `$AYA\_FILE` - a path to the currently processed markdown file 62 * `$AYA_FILE` - a path to the currently processed markdown file
63 * `$AYA\_URL` - a URL for the currently generated page 63 * `$AYA_URL` - a URL for the currently generated page
64 64
65 ## Example of RSS generation 65 ## Example of RSS generation
66 66
67 Extensions can be written in any language you know (Bash, Python, Lua, JavaScript, Go, even Assembler). Here's an example of how to scan all markdown blog posts and create RSS items: 67 Extensions can be written in any language you know (Bash, Python, Lua, JavaScript, Go, even Assembler). Here's an example of how to scan all markdown blog posts and create RSS items:
68 68
115 115
116 `aya watch` rebuilds your site every time you modify any file. 116 `aya watch` rebuilds your site every time you modify any file.
117 117
118 ## License 118 ## License
119 119
120 The software is distributed under the MIT license. 120 The software is distributed under the MIT/X11 license.
121 121
122 --- 122 ---
123 123
124 Ayaya~ 124 Ayaya~