gittech. site

for different kinds of informations and explorations.

Tiny Editor for Static Sites

Published at
Dec 23, 2024

Static Wiki Editor

Edit static sites without touching markdown or git!

  • ⚑️ Use static site generators like Hugo to build collaborative sites like wikis
  • πŸ€·β€β™‚οΈ Make editing easy for non-programmers
  • πŸŒ‡ Supports image uploads
  • πŸͺΆ Built on the flexible Quill editor

Example

screenshot

Usage

podman run -it --rm \
    --workdir /repo \
    -v /opt/my-repo:/repo \
    -p 8080:8080 \
    ghcr.io/jveski/static-wiki-editor:latest --addr=0.0.0.0:8080

Bootstrapping

If the current directory doesn't contain a git repo, the server will clone one from the URL given to --remote.

URL Convention

The server assumes all editable content is stored in the content directory relative to the root of the site's git repository i.e. current working directory. The URL to edit a particular page is prefixed with /edit and does not contain the file extension. So to edit the file content/foo/bar.md one would browse to the URL /edit/foo/bar.

Auth

The server expects a trusted reverse proxy (like oauth2-proxy) to set X-Forwarded-Email. Requests that do not set an email address will be denied. All authentication can be disabled by setting --allow-anonymous.