comparison README.md @ 86:897d57a7ec95 draft

Add support for disabling features at build time Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>
author yakumo.izuru
date Wed, 03 Apr 2024 23:17:16 +0000
parents d8c30f64e301
children 01ae2ad18ed1
comparison
equal deleted inserted replaced
85:64cd79d367b5 86:897d57a7ec95
13 * Easy to learn (you literally don't need to) 13 * Easy to learn (you literally don't need to)
14 * Fast (goes without saying) 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 provided you have Go (>=1.17) installed:
19 19
20 $ go install marisa.chaotic.ninja/aya/cmd/aya@latest (1) 20 $ go install marisa.chaotic.ninja/aya/cmd/aya@latest (1)
21 --- or --- 21 --- or ---
22 $ git clone https://git.chaotic.ninja/yakumo_izuru/aya 22 $ git clone https://git.chaotic.ninja/yakumo_izuru/aya
23 $ cd aya 23 $ cd aya
25 # make install 25 # make install
26 26
27 (1) If you use this method, the `aya version` subcommand may print the wrong string, 27 (1) If you use this method, the `aya version` subcommand may print the wrong string,
28 but it should not be a problem unless you use it on a page. 28 but it should not be a problem unless you use it on a page.
29 29
30 You can also disable certain features at build time, with the `-tags` switch.
31 Currently, these tags are available: `noamber`, `nogcss`.
32 See `go help buildconstraint` for more details.
33
30 ## Ideology 34 ## Ideology
31 35
32 Keep your texts in markdown, [amber](https://github.com/eknkc/amber), or html format right in the main directory 36 Keep your texts in markdown, [amber](https://github.com/eknkc/amber), or html format right in the main directory
33 of your blog/site. 37 of your blog/site.
34 38
35 Keep all service files (extensions, layout pages, deployment scripts etc) 39 Keep all service files (extensions, layout pages, deployment scripts etc)
36 in the `.aya` subdirectory. 40 in the `.aya` subdirectory.
37 41
38 Define variables in the header of the content files using [YAML](https://www.yaml.io) : 42 Define variables in the header of the content files using [YAML](https://noyaml.com) :
39 43
40 ```markdown 44 ```markdown
41 title: My web site 45 title: My web site
42 keywords: best website, hello, world 46 keywords: best website, hello, world
43 --- 47 ---