aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhistoria <[not public]>2026-07-02 16:43:51 -0400
committerhistoria <[not public]>2026-07-02 16:43:51 -0400
commit990f92017d4cabf8e28df0f615db8dac449edded (patch)
treee05b282832e65d786dcb2834b6706288d6bde98c
parentfec892047e4c0b810981fa8f20223e0b1c4f72b4 (diff)
downloadssg-blog-990f92017d4cabf8e28df0f615db8dac449edded.tar.gz
feat: rss title/description populated from args
-rw-r--r--README.md18
-rw-r--r--demo/dst/rss.xml4
-rwxr-xr-xssg-blog4
3 files changed, 21 insertions, 5 deletions
diff --git a/README.md b/README.md
index 8423c32..e3fcbf0 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,23 @@ See [https://romansolotarev.com/ssg.html](https://romanzolotarev.com/ssg.html) f
3. `chmod +x /usr/bin/ssg-blog`
4. `ssg-blog src dst 'https://my-website.net'`
-ssg-blog checks for subdirectories in the src directory, each of which becomes a category heading (non-recursively). It will generate a sorted list of links to any .md file in those directory (including nested directories). Each .md file may include frontmatter with the title and a YYYY-MM-DD date like this to be included in the index page:
+ssg-blog checks for subdirectories in the src directory, each of which becomes a category heading (non-recursively). It will generate a sorted list of links to any .md file in those directory (including nested directories).
+
+```
+ssg-blog/
+├─ src/
+│ ├─ category/
+│ │ ├─ article1_dir/
+│ │ │ ├─ article1.md
+│ │ │ ├─ some_assets/
+│ │ │ │ ├─ some_header.png
+│ │ ├─ article2.md
+│ │ ├─ article3.md
+│ ├─ another_category/
+...
+```
+
+Each .md file may include frontmatter with the title and a YYYY-MM-DD date like this to be included in the index page:
```markdown
---
diff --git a/demo/dst/rss.xml b/demo/dst/rss.xml
index 34d2e0a..b52750f 100644
--- a/demo/dst/rss.xml
+++ b/demo/dst/rss.xml
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
-<title>Blog</title>
+<title>https://example.org</title>
<link>https://example.org/</link>
-<description>Blog</description>
+<description>https://example.org</description>
<atom:link href="https://example.org/rss.xml" rel="self" type="application/rss+xml"/>
<item>
<title>This is a very interesting article about stamps</title>
diff --git a/ssg-blog b/ssg-blog
index 3c33dbe..398aa77 100755
--- a/ssg-blog
+++ b/ssg-blog
@@ -263,9 +263,9 @@ render_rss() {
echo '<?xml version="1.0" encoding="UTF-8"?>'
echo '<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">'
echo '<channel>'
- echo "<title>Blog</title>"
+ echo "<title>$base_url</title>"
echo "<link>$base_url/</link>"
- echo "<description>Blog</description>"
+ echo "<description>$base_url</description>"
echo "<atom:link href=\"$base_url/rss.xml\" rel=\"self\" type=\"application/rss+xml\"/>"
while IFS='|' read -r category date title url; do