diff options
Diffstat (limited to 'skaldpress.1')
| -rw-r--r-- | skaldpress.1 | 41 |
1 files changed, 12 insertions, 29 deletions
diff --git a/skaldpress.1 b/skaldpress.1 index a0cf224..d274b1c 100644 --- a/skaldpress.1 +++ b/skaldpress.1 @@ -6,7 +6,8 @@ Skaldpress \- Templating engine .SH DESCRIPTION .B smp -smp is a macro processor, made specifically for a usecase when doing templating of websites. +is a macro processor, made specifically for a usecase when doing templating of websites. +But it is useful for many other things as well. Macros which are available using skaldpress, in addition to the builtin smp(1)-macros @@ -16,34 +17,6 @@ Will output all documents which had the specified tag, using the specified templ 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. -.PP -All input files can have a metadata-block at the beginning. -Any keys will be defined as macros as \fBMETADATA_<key>\fR. -There are a few special keys which has a specific effect: - -.IP "\fBtags\fR" -This is a list, and all files with entries here will be registered during the first compilation round. -During the second compilation, macros like \fBall_tagged_by\fR will then -make all files with the relevant content available and compile it in. - -.IP "\fBtarget_filename\fR" -By default, a file will have the same name in the \fIoutput\fR-directory (unless a template has a different extension). -This overrides the output-filename, but it keeps the file in the same directory, and it will not affect the extension. - -.IP "\fBtemplate\fR" -If specified, the file will be compiled using a template. -In the template, all \fBMETADATA_<key>\fR macros will be available, -additionally templates can use the \fBCONTENT\fR-macro to get the expanded content of the file. -This is recursive, meaning that templates can use other templates, with their own metadata-block, -since it is recursive, any metadata in templates will overwrite any metadata from their children, -but will keep metadata that is not overwritten. -This means templates can add additional context. - -.IP "\fBkeep_states\fR" -List or string where every listed state/variable will be kept for subsequenct compilations. -Meaning that you can e.g. construct a array in the first compilation, which is then used the second time around. -Setting this, means that the file will always be recompiled, regardeless of other instances (unless a \fB--filter\fR is set). - .SH OPTIONS .IP "\fB-o, --out, --output\fR \fIpath\fR Specifies the directory to output the compiled files to, defaults to \fIbuild\fR. @@ -65,10 +38,20 @@ will be compiled. Comma-separated list of files to exclude, if not specified, all files in \fB--source\fR will be compiled. +.IP "\fB-x, --xclude\fR \fIfilter\fR +Comma-separated list of static files to exclude, if not specified, all files in \fB--static\fR +will be compiled. + .IP "\fB-m, --metadata\fR \fIkey\fR=\fIvalue\fR Metadata to add to compiled file, this can e.g. set a template for all files if you don't want to manually add YAML-blocks. Specify multiple times, to set multiple fields. +.IP "\fB-D, --define\fR \fIkey\fR=\fIvalue\fR +Define macros, these will be interpreted as strings. + +.IP "\fB-P, --prefix-builtins\fR +Prefix all builtin macros with `smp_` + .SH EXAMPLES To run skaldpress on a simple project, simply call it with no arguments |