mksite.1

.\" Generated by scdoc 1.11.1
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "mksite" "1" "2022-10-18"
.P
.SH NAME
.P
mksite - generate a website from template files
.P
.SH SYNOPSIS
.P
\fBmksite\fR [\fB-q\fR | \fB--log-level\fR \fIlevel\fR ] \fIcommand\fR
.br
\fBmksite -V\fR
.br
\fBmksite -h\fR
.P
.SH DESCRIPTION
.P
\fBmksite\fR is a tool for generating a static website using the information in the
‘mksite.\&toml’ file in the working directory, the template files in the
configured source directory, and the static assets in the configured asset
directory, if any.\&
.P
.SH OPTIONS
.P
\fB-q\fR, \fB--quiet\fR
.RS 4
Do not print log messages.\& Conflicts with \fB--log-level\fR option.\&
.P
.RE
\fB--log-level\fR \fILEVEL\fR
.RS 4
Enable logging at the given level (error, warn, info, or debug).\& Defaults to
info.\& Conflicts with \fB-q\fR.\&
.P
.RE
\fB-h\fR, \fB--help\fR
.RS 4
Print help information and exit.\&
.P
.RE
\fB-V\fR, \fB--version\fR
.RS 4
Print version information and exit.\&
.P
.RE
.SS COMMANDS
.P
\fBbuild\fR
.RS 4
Build the website according to the ‘mksite.\&toml’ config file.\&
.P
.RE
\fBclean\fR
.RS 4
Delete all build outputs.\&
.P
.RE
\fBinit\fR
.RS 4
Initialize a scaffold ‘mksite.\&toml’ file in the current working directory.\&
.P
.RE
\fBnew\fR \fINAME\fR
.RS 4
Create a new directory \fINAME\fR and scaffold a website and config file in it.\&
.P
.RE
\fBhelp\fR [\fISUBCOMMAND\fR]
.RS 4
Print help information or the help of the given subcommand.\&
.P
.RE
.SH EXIT STATUS
.P
\fBmksite\fR exits 0 on success, 2 if the provided command-line arguments are
incorrect, and 1 if any other error occurs.\&
.P
.SH FILES
.P
In order to run the \fBbuild\fR or \fBclean\fR subcommands, \fBmksite\fR requires the
precense of a file named ‘mksite.\&toml’ in the working directory.\& This file is
generated by the \fBinit\fR and \fBnew\fR subcommands.\&
.P
.SH NOTES
.P
For documentation on the configuration format and expected directory structure,
see https://alterae.\&github.\&io/mksite.\&
.P
For documentation on the Tera templating language, which \fBmksite\fR uses, see
https://tera.\&netlify.\&app.\&
.P
.SH BUGS
.P
\fBmksite\fR is in active development, and highly incomplete.\& Many important
features are missing.\&
.P
.SH AUTHORS
.P
\fBmksite\fR is maintained by alterae <alterae@pm.\&me>.\&
.P
.TS
l l
l l.
T{
\fBWebsite:\fR
T}	T{
https://alterae.\&github.\&io/mksite
T}
T{
\fBSource code:\fR
T}	T{
https://github.\&com/alterae/mksite
T}
.TE
.sp 1
.SH REPORTING BUGS
.P
Issues can be filed at https://github.\&com/alterae/mksite/issues.\&