commit 5092b0a5d08372bb2de151ca6797dca42b45a3e1
parent ffbd95acd986489ab187c81f369e2056c71298c0
Author: Jake Bauer <jbauer@paritybit.ca>
Date: Wed, 17 Aug 2022 18:40:28 -0400
Update documentation
Diffstat:
| M | sbs.1 | | | 25 | ++++++++++++++++++------- |
1 file changed, 18 insertions(+), 7 deletions(-)
diff --git a/sbs.1 b/sbs.1
@@ -10,17 +10,20 @@
.Sh DESCRIPTION
.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.
+more complicated generators such as Hugo or Jekyll. It supports compiling both
+gemtext and markdown into HTML.
.Pp
Commands are as follows:
.Bl -tag -width Ds
.It Cm build Ar
-Build the given markdown file(s), sandwiching the content of each given markdown
-file between the template header and footer files and placing the resulting
-files in the ./static/ directory.
+Build the given markdown or gemtext file(s), sandwiching the content of each
+given file between the template header and footer files and placing the
+resulting files in the ./static/ directory. If run without arguments, build
+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.
+outputting the file to ./static/feed.xml. Note that posts under the blog
+directory must be in markdown format.
.It Cm new Ar subcommand
.Bl -tag -width Ds
.It page Ar file
@@ -68,6 +71,9 @@ nl).
The arguments passed to lowdown which tell it how to compile given pages. This
option is set to a sensible default and should not be changed under normal
circumstances.
+.It pushcmd
+The command sbs will use for publishing your site (e.g. rsync -rv static/*
+user@website:/var/www/html, ssh user@website "cd /var/www/html; git pull", etc.)
.El
.Sh EXIT STATUS
.Nm
@@ -77,8 +83,9 @@ To create a new site called "example.com":
.Pp
.Dl sbs new site example.com
.Pp
-All of the following commands must be run from within a given site's directory.
-The examples below assume the webmaster is currently inside of the newly created
+All of the following commands must be run from within the root of a given site's
+directory (i.e. the example.com/ directory, not any subdirectory). The examples
+below assume the webmaster is currently inside of the newly created
"example.com" directory and has edited the files and configuration generated by
sbs to their liking.
.Pp
@@ -96,6 +103,10 @@ created files:
.Pp
.Dl sbs build content/index.md content/blog/hello-world.md
.Pp
+Or, simply run:
+.Pp
+.Dl sbs build
+.Pp
To generate an Atom feed containing all posts under the configured blog
directory (which will just be a single post in this example):
.Pp
