Skip to content

sermuns/stil

Repository files navigation


stil is a dead simple static site generator that replicates the experience of viewing a dynamically generated index listing produced by web servers such as nginx and apache.

👉 See what stil generates for this repo: https://stil.samake.se/demo/

Usage

generate STatic site from Index Listing of directory

Usage: stil [OPTIONS] [INPUT_DIR]

Arguments:
  [INPUT_DIR]  Which directory to generate listing of [default: .]

Options:
  -o, --output-dir <OUTPUT_DIR>  Which directory to write generated HTML to [default: public]
  -t, --title <TITLE>            Which <title> to give the generated HTML [default: stil]
  -i, --ignored <IGNORED>        Which files/directories to NOT include in the output
  -u, --url-path <URL_PATH>      On which path the final page will be deployed [default: /]
  -h, --help                     Print help
  -V, --version                  Print version

Installation

For each version, prebuilt binaries are automatically built for Linux, MacOS and Windows.

  • You can download and unpack the latest release from the releases page.

  • Using cargo-binstall

    cargo binstall stil
  • Using ubi:

    ubi -p sermuns/stil
  • From source with Cargo

    cargo install stil

Actually, you don't need to install locally. It works fine in docker container:

docker run -v $(pwd):/app -u $(id -u):$(id -g) ghcr.io/sermuns/stil <arguments to stil>

TODO

  • ability to sort listing by column
  • see thumbnails of photos/videos
    • (implement grid view, not just list view?)