Changeset 65 in code for trunk

Timestamp:

May 7, 2023, 1:59:02 PM (2 years ago)

Author:

Izuru Yakumo

Message:

Update documentation

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

Location:

trunk

Files:

• README.md (modified) (5 diffs)
• cmd/aya/main.go (modified) (4 diffs)

trunk/README.md

@@ -3 +3 @@
 aya is an extremely minimal static site generator written in Go.
 
-This crow tengu stands for 'the fastest one in Gensokyo' and yes this is also a Touhou Project reference.
+Named after [Aya Shameimaru](https://en.touhouwiki.net/wiki/Aya_Shameimaru) from [Touhou 9.5: Shoot the Bullet](https://en.touhouwiki.net/wiki/Shoot_the_Bullet)
 
 ## Features
@@ -12 +12 @@
 * Works well for blogs and generic static websites (landing pages etc)
 * Easy to learn
-* Fast
+* Fast (duh!)
 
 ## Installation
@@ -19 +19 @@
 
         $ go install marisa.chaotic.ninja/aya/cmd/aya@latest
-
+        --- or ---
+        $ git clone https://git.chaotic.ninja/yakumo.izuru/aya
+        $ cd aya
+        $ make
+        # make install
+        
 ## Ideology
 
@@ -57 +62 @@
 
 ``` bash
-for f in ./blog/*.md ; do
-        d=$($AYA var $f date)
-        if [ ! -z $d ] ; then
-                timestamp=`date --date "$d" +%s`
-                url=`$AYA var $f url`
-                title=`$AYA var $f title | tr A-Z a-z`
-                descr=`$AYA var $f description`
-                echo $timestamp \
-                        "<item>" \
-                        "<title>$title</title>" \
-                        "<link>http://zserge.com/$url</link>" \
-                        "<description>$descr</description>" \
-                        "<pubDate>$(date --date @$timestamp -R)</pubDate>" \
-                        "<guid>http://zserge.com/$url</guid>" \
-                "</item>"
-        fi
-done | sort -r -n | cut -d' ' -f2-
+#!/bin/sh
+echo "Generating RSS feed"
+
+echo '<?xml version="1.0" encoding="utf-8"?>' > $AYA_OUTDIR/blog/rss.xml
+echo '<rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/">' >> $AYA_OUTDIR/blog/rss.xml
+echo '<channel>' >> $AYA_OUTDIR/blog/rss.xml
+for f in ./blog/*/*.md ; do
+    d=$($AYA var $f date)
+    if [ ! -z $d ] ; then
+        timestamp=`gdate --date "$d" +%s`
+        url=`$AYA var $f url`
+        title=`$AYA var $f title | tr A-Z a-z`
+        descr=`$AYA var $f description`
+        echo $timestamp "<item><title>$title</title><link>https://technicalmarisa.chaotic.ninja/blog/$url</link><description>$descr</description><pubDate>$(gdate --date @$timestamp -R)</pubDate><guid>http://technicalmarisa.chaotic.ninja/blog/$url</guid></item>"
+    fi
+done | sort -r -n | cut -d' ' -f2- >> $AYA_OUTDIR/blog/rss.xml
+echo '</channel>' >> $AYA_OUTDIR/blog/rss.xml
+echo '</rss>' >> $AYA_OUTDIR/blog/rss.xml
 ```
 
@@ -87 +93 @@
         lessc < $AYA_OUTDIR/styles.less > $AYA_OUTDIR/styles.css
         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)
 
 ## Command line usage

trunk/cmd/aya/main.go

@@ -1 @@
-// $TheSupernovaDuo: cmd/aya/main.go,v 0.5.x 2023/4/26 8:49:6 yakumo_izuru Exp $
+// $TheSupernovaDuo: cmd/aya/main.go,v 0.5.x 2023/5/7 10:57:10 yakumo_izuru Exp $
 package main
 
@@ -301 +301 @@
         return err
 }
-
+// This function passes the files to build to their corresponding functions
 func build(path string, w io.Writer, vars Vars) error {
         ext := filepath.Ext(path)
@@ -368 +368 @@
         log.Fatal(http.ListenAndServe(":8000", nil))
 }
-
+// Initialize the environment
 func init() {
         // prepend .aya to $PATH, so plugins will be found before OS commands
@@ -375 +375 @@
         os.Setenv("PATH", p)
 }
-
+// Print usage notes
 func printUsage() {
         fmt.Printf("%v <command> [args]\n", os.Args[0])