Changeset 80 in code for trunk/README.md

Timestamp:

Dec 12, 2023, 2:09:17 PM (18 months ago)

Author:

Izuru Yakumo

Message:

A good time to finally release a stable version

Signed-off-by: Izuru Yakumo <yakumo.izuru@…>

File:

• trunk/README.md (modified) (5 diffs)

trunk/README.md

@@ -18 +18 @@
 Build it manually assuming you have Go (>=1.17) installed:
 
-        $ go install marisa.chaotic.ninja/aya/cmd/aya@latest
+        $ go install marisa.chaotic.ninja/aya/cmd/aya@latest (1)
         --- or ---
         $ git clone https://git.chaotic.ninja/yakumo.izuru/aya
@@ -24 +24 @@
         $ make
         # make install
-        
+
+(1) If you use this method, the `aya version` subcommand may print the wrong string,
+but it should not be a problem unless you use it on a page.
+
 ## Ideology
 
-Keep your texts in markdown, or HTML format right in the main directory
+Keep your texts in markdown, [amber](https://github.com/eknkc/amber), or html format right in the main directory
 of your blog/site.
 
@@ -33 +36 @@
 in the `.aya` subdirectory.
 
-Define variables in the header of the content files using [YAML]:
+Define variables in the header of the content files using [YAML](https://www.yaml.io) :
 
-        title: My web site
-        keywords: best website, hello, world
-        ---
+```markdown
+title: My web site
+keywords: best website, hello, world
+---
 
-        Markdown text goes after a header *separator*
+Markdown text goes after a header *separator*
+```
 
 Use placeholders for variables and plugins in your markdown or html
@@ -47 +52 @@
 subdiretory.
 
-Everything the extensions prints to stdout becomes the value of the
+Everything the extensions prints to [stdout](https://man.freebsd.org/cgi/man.cgi?fd) becomes the value of the
 placeholder.
 
-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:
+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:
 
 * `$AYA` - a path to the `aya` executable
@@ -94 +100 @@
         rm -f $AYA_OUTDIR/styles.css
 
-## Extras
-
-`aya` also supports generating `.html` and `.css` by means of using `.amber`
-and `.gcss` files. See more at [eknkc/amber](https://github.com/eknkc/amber) [yosssi/gcss](https://github.com/yosssi/gcss)
+Note, you can also place `.gcss` files for [gcss](https://github.com/yosssi/gcss) to process instead
 
 ## Command line usage