make-web/README.md

44 lines
1.2 KiB
Markdown
Raw Normal View History

2023-10-24 08:13:16 +02:00
# This is a BSD Makefile base webpage generator.
2023-10-23 13:29:14 +02:00
Pretty minimal... no features at all.
2023-10-24 08:13:16 +02:00
## Requirements:
2023-10-23 13:29:14 +02:00
- BSD make (written and tested on OpenBSD)
- discount (for parsing markdown file)
- asciidoctor + asciidoctor-diagram extension (for parsing asciidoctor files)
- ksh (for shell stuff)
- rsync (to copy static files)
2023-10-24 08:13:16 +02:00
## Basic operation:
2023-10-23 13:29:14 +02:00
src/header.th gets prepended to every file.
src/footer.th gets appended to every file.
.pa files contain asciidoctor source.
.pm files contain markdown source.
.ph files contain plain html.
2023-10-24 08:13:16 +02:00
.ps files contain ksh shell script (the scripts must output html code to stdout).
2023-10-23 22:39:52 +02:00
.pt files contain plain text.
2023-10-23 13:29:14 +02:00
2023-10-23 22:39:52 +02:00
Execute `make debug` to create the website with debug output.
Execute `make` to hide the debug output.
2023-10-24 08:13:16 +02:00
Execute `make install` to copy the page to the remote host.
2023-10-23 13:31:17 +02:00
The generated website will be in the directory `www`.
2023-10-24 08:13:16 +02:00
Execute `make clean` to delete www.
## Configuration
Configuration happens in the `.control`. Toggles are files and their
content is the value.
Configure the remote host for `make install`.
```
echo "user@my-server.de:/var/www" > .control/remote-ssh-host
```
Everything in `.control/static-files` is copied as is (supports globbing).