aboutsummaryrefslogtreecommitdiffstats
path: root/man/ssg-init.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/ssg-init.1')
-rw-r--r--man/ssg-init.1100
1 files changed, 55 insertions, 45 deletions
diff --git a/man/ssg-init.1 b/man/ssg-init.1
index 47dd2bb..909801b 100644
--- a/man/ssg-init.1
+++ b/man/ssg-init.1
@@ -1,45 +1,55 @@
-.TH SSG-INIT 1 "2026-01-01" "ssg" "General Commands Manual"
-.SH NAME
-ssg-init \- initialize a new site
-.SH SYNOPSIS
-.B ssg init
-.RI [ directory ]
-.SH DESCRIPTION
-Create a new site with the standard directory structure:
-.PP
-.RS
-.nf
-data/
-templates/
-static/
-.fi
-.RE
-.PP
-If no directory is specified, initializes in the current directory.
-A sample
-.I templates/index.html
-is created if one does not exist.
-.SH EXAMPLES
-Initialize in the current directory:
-.PP
-.RS
-.nf
-$ ssg init
-.fi
-.RE
-.PP
-Initialize a new site:
-.PP
-.RS
-.nf
-$ ssg init mysite
-$ cd mysite
-$ ssg build
-.fi
-.RE
-.SH SEE ALSO
-.BR ssg-build (1)
-.SH SSG
-Part of the
-.BR ssg (1)
-suite.
+.Dd January 2, 2026
+.Dt SSG-INIT 1
+.Os
+.Sh NAME
+.Nm ssg-init
+.Nd initialize a new site
+.Sh SYNOPSIS
+.Nm ssg init
+.Op Fl h | -help
+.Ar [directory]
+.Sh DESCRIPTION
+.Nm
+creates a new site with the standard directory structure:
+.Pp
+.Bl -item -offset indent -compact
+.It
+.Pa data/
+.It
+.Pa templates/index.html
+.It
+.Pa static/
+.El
+.Pp
+If no
+.Ar directory
+is specified, initializes in the current directory. A sample
+.Qq hello world
+.Pa templates/index.html
+is created if the file does not already exist.
+.Pp
+.Ar directory
+can be any relative path from the current working directory or any absolute path. If any subdirectories are missing along the given path, they will be created with 755 permissions.
+.Sh OPTIONS
+.Bl -tag -width Ds
+.It Fl h , Fl -help
+Print brief usage information.
+.El
+.Sh EXIT STATUS
+.Nm
+exits 0 on success, and >0 if an error occurs.
+.Sh EXAMPLES
+Initialize a site in the current directory:
+.Dl $ ssg init
+.Pp
+Initialize, build, and serve a new site in a subdirectory:
+.Dl $ ssg init mysite
+.Dl $ cd mysite
+.Dl $ ssg build
+.Dl $ ssg serve
+.Pp
+.Sh SEE ALSO
+.Xr ssg 1 ,
+.Xr ssg-build 1 ,
+.Xr ssg-serve 1 ,
+.Xr ssg-templates 5