sbs

commit cc1992d1d0947edd5c7c10b8705a4bc3a3b6d64b
parent 885ed0981dcd92e526674802d7c997bbdaf00fa6
Author: Jake Bauer <jbauer@paritybit.ca>
Date:   Sat, 20 Aug 2022 19:17:07 -0400

Improve documentation

Diffstat:
M
sbs
 | 
2
+-
M
sbs.1
 | 
4
++--

2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/sbs b/sbs
@@ -288,7 +288,7 @@ case "$1" in
 		echo "v0.5.0" ;
 		;;
 	*)
-		echo "Usage: sbs <command> [FILE ...]"
+		echo "See sbs(1) for documentation."
 		;;
 esac
 
diff --git a/sbs.1 b/sbs.1
@@ -11,7 +11,7 @@
 .Nm
 is a static site builder designed to fill a gap between writing HTML by hand and
 more complicated generators such as Hugo or Jekyll. It supports compiling both
-gemtext and markdown into HTML.
+gemtext and markdown into HTML, but primarily works with Markdown documents.
 .Pp
 Commands are as follows:
 .Bl -tag -width Ds
@@ -23,7 +23,7 @@ everything under the ./content/ directory.
 .It Cm genfeed
 Compile an Atom feed from all posts found under the configured blog directory,
 outputting the file to ./static/feed.xml. Note that posts under the blog
-directory must be in markdown format.
+directory must be in markdown format only.
 .It Cm new Ar subcommand
 .Bl -tag -width Ds
 .It page Ar file