changeset 64:0716397c44e8 draft

Update documentation Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>
author yakumo.izuru
date Sun, 07 May 2023 13:59:02 +0000
parents 1bd8a674a30c
children 6d985efa0f7a
files README.md cmd/aya/main.go
diffstat 2 files changed, 35 insertions(+), 24 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Sat Apr 29 04:42:07 2023 +0000
+++ b/README.md	Sun May 07 13:59:02 2023 +0000
@@ -2,7 +2,7 @@
 
 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
 
@@ -11,14 +11,19 @@
 * Highly extensible
 * Works well for blogs and generic static websites (landing pages etc)
 * Easy to learn
-* Fast
+* Fast (duh!)
 
 ## Installation
 
 Build it manually assuming you have Go installed:
 
 	$ 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
 
 Keep your texts in markdown, or HTML format right in the main directory
@@ -56,23 +61,24 @@
 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:
 
 ``` 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
 ```
 
 ## Hooks
@@ -87,6 +93,11 @@
 	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
 
 `aya build` re-builds your site.
--- a/cmd/aya/main.go	Sat Apr 29 04:42:07 2023 +0000
+++ b/cmd/aya/main.go	Sun May 07 13:59:02 2023 +0000
@@ -1,4 +1,4 @@
-// $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
 
 import (
@@ -300,7 +300,7 @@
 	_, err = io.Copy(w, in)
 	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)
 	if ext == ".md" || ext == ".mkd" || ext == ".markdown" {
@@ -367,14 +367,14 @@
 	log.Printf("Serving %v at port 8000, see http://localhost:8000", rootdir)
 	log.Fatal(http.ListenAndServe(":8000", nil))
 }
-
+// Initialize the environment
 func init() {
 	// prepend .aya to $PATH, so plugins will be found before OS commands
 	p := os.Getenv("PATH")
 	p = os.Getenv("PWD") + "/" + AYADIR + ":" + p
 	os.Setenv("PATH", p)
 }
-
+// Print usage notes
 func printUsage() {
 	fmt.Printf("%v <command> [args]\n", os.Args[0])
 	fmt.Printf("\n")