diff options
| author | Ruben Beltran del Rio <git@r.bdr.sh> | 2025-10-01 22:18:28 +0200 |
|---|---|---|
| committer | Ruben Beltran del Rio <git@r.bdr.sh> | 2025-10-01 22:18:28 +0200 |
| commit | e26d1da40e42ccb8e62c57a41fee2607d75812a3 (patch) | |
| tree | 10fbe10df735215aa1f4e655c979bc6f30696274 /man | |
| parent | 2ea9dc0ea11c3fa6aeb8768537c3b48c67881d7a (diff) | |
Use XDG_CACHE_HOME for output.
Diffstat (limited to 'man')
| -rw-r--r-- | man/page.1 | 24 |
1 files changed, 20 insertions, 4 deletions
@@ -1,4 +1,4 @@ -.TH PAGE 1 "2024-03-13" "1.4.1" "Page Manual" +.TH PAGE 1 "2025-10-01" "2.0.0" "Page Manual" .SH NAME page \- gemtext based static website generation tool for gemini and http. .SH SYNOPSIS @@ -9,8 +9,24 @@ page is a tool that lets you create a static website from a directory of gemtext files. .PP To use, go to the directory containing the site, and run \fBpage\fR. It will -create two directories in the parent directory using the same name but -appending \fB_html\fR and \fB_gemini\fR. +create +.B html +and +.B gemini +directories inside +.B $PAGE_OUTPUT_DIRECTORY/page/<basename>\fR, +.B $XDG_CACHE_HOME/page/<basename>\fR, +or +.B ~/.cache/page/<basename> +in that order of precedence, where +.B <basename> +is the name of the current directory. +.SH ENVIRONMENT VARIABLES +You can configure the output location of the page using environment variables. +.TP +.B PAGE_OUTPUT_DIRECTORY +Sets the location for the generated static files ready to be published. +Defaults to \fI$XDG_CACHE_HOME/blog\fR, and falls back to \fI~/.cache/blog\fR. .SH FOLDER STRUCTURE The website directory has some requirements for page to work correctly. It must contain \fIgemtext\fR and a \fIlayout\fR, and optionally may contain @@ -86,7 +102,7 @@ For example: Any file that isn't gemtext or the layout will be copied as-is. This includes hidden files! The only ones that are excluded are .git and .gitignore. .SH VERSION -.BR 1.4.1 +.BR 2.0.0 .SH HOMEPAGE .I https://r.bdr.sh/page.html .SH AUTHORS |