aboutsummaryrefslogtreecommitdiff
path: root/README.md
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 /README.md
parentfec892047e4c0b810981fa8f20223e0b1c4f72b4 (diff)
downloadssg-blog-990f92017d4cabf8e28df0f615db8dac449edded.tar.gz
feat: rss title/description populated from args
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 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
---