website-redirector/README.md

18 lines
831 B
Markdown
Raw Normal View History

2024-04-20 13:27:05 +02:00
# website-redirector
Execute `build.sh` to create default links used on StarOpenSource's infrastructure.
# Creating custom links
To create your own links, use this: `env LINKGEN_NO_DEFAULT=y ./build.sh <link name (aka. the file name without '.html')> <link title> <link url>`
# Environment variables
## `LINKGEN_VERBOSE`
Displays all executed commands if set.
## `LINKGEN_TRASH_OUT_DIR`
Removes the `out` directory when run if set. Leave unset if `LINKGEN_NO_DEFAULT` is set unless you want all your custom links removed.
## `LINKGEN_NO_DEFAULT`
Disables the generation of StarOpenSource's default links. Set this if you want to add custom links.
# Replacing the template
You can (if you want) replace the `template.html` file with some content of your own. \
You can use the `_TITLE_` (link title) and `_RDLINK_` placeholders.