annotate doc.go @ 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 e8eb1fdb4b03
children d8c30f64e301
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
68
4b79810863f6 Ready to release 0.6.0
yakumo.izuru
parents: 67
diff changeset
1 // Package aya is [...]
67
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
2
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
3 // Aya is the fastest static site generator
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
4 // Requires zero configuration to get started
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
5 // Named after Aya Shameimaru from Touhou Project
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
6
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
7 // Current subcommands available:
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
8 // build -- Generate the site, result can be found at .pub
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
9 // build [file] -- Only generate the argument passed to standard output
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
10 // serve -- Spawn an HTTP server in localhost port 8000, serving the .pub directory
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
11 // var [file] -- Query variables from a markdown file
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
12 // version -- Print version and exit
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
13 // watch -- (Re)generate site while looking for changes
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
14
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
15 // Aya is licensed under the MIT license
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
16 // This is a hard fork of git.mills.io/prologic/zs, which in turn is a fork of zserge's zs
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
17 // This one (re)incorporates the features removed in the former from the latter
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
18
76
e8eb1fdb4b03 Passed through golint only to get a load of garbage
yakumo.izuru
parents: 71
diff changeset
19 // Copyright (c) 2014 Serge Zaitsev <hello@zserge.com>
e8eb1fdb4b03 Passed through golint only to get a load of garbage
yakumo.izuru
parents: 71
diff changeset
20 // Copyright (c) 2023 Izuru Yakumo <yakumo.izuru@chaotic.ninja>
71
7819959ac6ca feat: move the blackfriday extension settings out of the render function, improve documentation
yakumo.izuru
parents: 69
diff changeset
21
67
4edfa07d5fe0 bfchroma turned out to be a hassle
yakumo.izuru
parents:
diff changeset
22 // Ayaya~
71
7819959ac6ca feat: move the blackfriday extension settings out of the render function, improve documentation
yakumo.izuru
parents: 69
diff changeset
23 package aya