summaryrefslogblamecommitdiff
path: root/skaldpress.1
blob: 718557ae6b52a803aa577fbb150de3f39ef52091 (plain) (tree)





















                                                                                            
                                         

                                                                                 



                                                                                























                                                                                       
.TH SKALDPRESS 1 2024-06-08
.SH name
Skaldpress \- Templating engine
.SH SYNOPSIS
.B skaldpress [OPTIONS]

.SH DESCRIPTION
.B smp
smp is a macro processor, made specifically for a usecase when doing templating of websites.


Macros which are available using skaldpress, in addition to the builtin smp(1)-macros
.IP "\fBtemplate(<template>,<content>)\fR"
Will process the content using a template, in-place.
This macro is used by the \fBall_tagged_by\fR-macro.

.IP "\fBall_tagged_by(<tag_name>,<template>[,<field to sort by>][,<reversed>])\fR"
Will output all documents which had the specified tag, using the specified template.
If a field to sort by is specified, it will output ascending based on that field,
or reversed if a fourth argument \fBreversed\fR is specified.

.SH OPTIONS
.IP "\fB-o, --out, --output\fR \fIpath\fR
Specifies the directory to output the compiled files to, defaults to \fIbuild\fR.

.IP "\fB-i, --input\fR \fIpath\fR
Specifies the directory where all files are iterated, defaults to \fIcontent\fR.

.IP "\fB-s, --static\fR \fIpath\fR
Specifies the directory where all files are iterated, defaults to \fIcontent\fR.

.IP "\fB-t, --templates\fR \fIpath\fR
Specifies the directory where templates are stored, defaults to \fItemplates\fR.

.IP "\fB-f, --filter\fR \fIfilter\fR
Comma-separated list of files to compile, if not specified, all files in \fB--source\fR
will be compiled.

.SH EXAMPLES

To run skaldpress on a simple project, simply call it with no arguments
in a directory where you have a \fBcontent\fR-directory,
and optionally a \fBtemplates\fR-directory.
.PP
.nf
.RS
skaldpress
.RE
.fi
.PP

.SH SEE ALSO
smp(1)