IceWreck / OnePageWiki

Fast, easily editable, zero javascript single page wiki. Built in Go.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

OnePageWiki

Single page markdown wiki.

Use Case: When you want a webpage thats easily editable and no other BS. Zero JS.

screenshot

Deployment Instructions:

  • Create a binary using go build -o OnePageWiki .
  • Create a new folder called Wiki on your server.
  • Copy the binary and the following files/folders: templates, static, config.env, wiki.md into that folder.
  • chmod +x OnePageWiki
  • Create a systemd service for the binary.
  • If you want https, use a reverse proxy.

Configuration

You can change configuration in config.env. If you want a hashed wiki editor password instead of plaintext, you can edit config.go to use bcrypt.

WIKIUSER="admin"
WIKIPASS="password"
WIKIPORT=8000
WIKITITLE="OnePageWiki"
WIKIMARKDOWNFILE="./wiki.md"

Uncomment the dark mode section in static/css/style.css for dark mode.

Other

Used libraries: go-chi, goldmark markdown parser, godotenv, Marx CSS. Built this entire thing in less than two hours.

About

Fast, easily editable, zero javascript single page wiki. Built in Go.

License:MIT License


Languages

Language:Go 65.6%Language:HTML 17.9%Language:CSS 15.3%Language:Shell 1.1%