comparison README.md @ 74:d8727551f403 draft

The Empress (III) * Change the way how versions are handled in version.go (to ease `go install`) * Upgrade yaml.v2 to yaml.v3 Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>
author yakumo.izuru
date Mon, 04 Dec 2023 00:54:29 +0000
parents 4edfa07d5fe0
children 7b122b71fcfa
comparison
equal deleted inserted replaced
73:8533d875a2bb 74:d8727551f403
8 8
9 * Zero configuration (no configuration file needed) 9 * Zero configuration (no configuration file needed)
10 * Cross-platform 10 * Cross-platform
11 * Highly extensible 11 * Highly extensible
12 * Works well for blogs and generic static websites (landing pages etc) 12 * Works well for blogs and generic static websites (landing pages etc)
13 * Easy to learn 13 * Easy to learn (you literally don't need to)
14 * Fast (duh!) 14 * Fast (goes without saying)
15 15
16 ## Installation 16 ## Installation
17 17
18 Build it manually assuming you have Go (>=1.17) installed: 18 Build it manually assuming you have Go (>=1.17) installed:
19 19
50 placeholder. 50 placeholder.
51 51
52 Every variable from the content header will be passed via environment variables like `title` becomes `$AYA_TITLE` and so on. There are some special variables: 52 Every variable from the content header will be passed via environment variables like `title` becomes `$AYA_TITLE` and so on. There are some special variables:
53 53
54 * `$AYA` - a path to the `aya` executable 54 * `$AYA` - a path to the `aya` executable
55 * `$AYA_OUTDIR` - a path to the directory with generated files 55 * `$AYA\_OUTDIR` - a path to the directory with generated files
56 * `$AYA_FILE` - a path to the currently processed markdown file 56 * `$AYA\_FILE` - a path to the currently processed markdown file
57 * `$AYA_URL` - a URL for the currently generated page 57 * `$AYA\_URL` - a URL for the currently generated page
58 58
59 ## Example of RSS generation 59 ## Example of RSS generation
60 60
61 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: 61 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:
62 62