OnePageWiki

command module
v0.0.0-...-7fd5371 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 1, 2021 License: MIT Imports: 8 Imported by: 0

README

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.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL