tilde-wiki/README.org

1.3 KiB

tilde-wiki

being a small tool for managing a wiki on a social unix server

This is a new project. It's a formalization of the strange 777 /home/wiki user that has existed on tilde.town since time immemorial.

You can think of this project as a very special-cased static site generator with as few features as possible.

For now, check out the rfc.

using this tool

this tool is super specific to tilde.town, but more or less adaptable to similar environments. if there are things you think should change to make this more useful elsewhere, PRs and issues are welcome.

prequisites

  • a git repo with a top level path src/articles
  • the files src/{footer.md,header.md} which contain whatever header and footer content you'd like
  • everything in src/articles to be either a markdown (.md), html (.html), or plain text (.txt) file
  • write privileges for anyone who clones the repo
  • a post-receive hook with something like the following:

    #!/bin/bash
    umask 002
    unset GIT_DIR
    
    cd /wiki
    git reset --hard HEAD
    git log -1 > git-last-log.txt

    (you will want to replace /wiki with whatever the path to your wiki repo is)

author

license

GPLv3, u kno it