luzifer/wiki
1
0
Fork 0
mirror of https://github.com/Luzifer/wiki.git synced 2024-11-08 06:40:09 +00:00
Code Issues Releases Wiki Activity
File-based Wiki implementation with web-editing capabilities and a Git backed storage
10 commits 1 branch 7 tags 4.6 MiB
Go 40.6%
Vue 29.7%
CSS 7.5%
Shell 5.9%
JavaScript 5.5%
Other 10.8%
Find a file
Knut Ahlers bbba71a9c3
Add Usage 
Signed-off-by: Knut Ahlers <knut@ahlers.me>
2019-08-07 08:14:42 +02:00
frontend Re-generate frontend code 2019-08-07 07:40:15 +02:00
src Initial implementation 2019-08-05 00:42:41 +02:00
.gitignore Initial implementation 2019-08-05 00:42:41 +02:00
.repo-runner.yaml Add build files 2019-08-07 07:40:07 +02:00
assets.go Re-generate frontend code 2019-08-07 07:40:15 +02:00
docker-entrypoint.sh Add dockerized version 2019-08-07 08:01:59 +02:00
Dockerfile Add dockerized version 2019-08-07 08:01:59 +02:00
go.mod Implement git integration for history 2019-08-07 07:23:11 +02:00
go.sum Implement git integration for history 2019-08-07 07:23:11 +02:00
History.md prepare release v0.1.0 2019-08-07 08:02:27 +02:00
LICENSE Add META 2019-08-07 07:31:56 +02:00
main.go Implement git integration for history 2019-08-07 07:23:11 +02:00
Makefile Add build files 2019-08-07 07:40:07 +02:00
README.md Add Usage 2019-08-07 08:14:42 +02:00
storage.go Implement git integration for history 2019-08-07 07:23:11 +02:00
storage_test.go Initial implementation 2019-08-05 00:42:41 +02:00

README.md

Go Report Card

Luzifer / wiki

wiki is a small file-based Wiki implementation with web-editing capabilities and a Git backed storage for history of pages.

The goal of this project was to have a small application to be deployed without any dependencies to open a Wiki for note taking or documentation purpose.

The software itself has no concept of users or authentication and is held as simple as possible. Saved pages are stored as plain Markdown file onto the local disk inside a Git repository which on the one hand can be used to backup the state (just add a remote and set up a cron to push changes) and on the other hand to recover contents if someone deleted contents from a page.

Usage

# wiki --help
Usage of wiki:
      --data-dir string    Directory to store data to (default "./data/")
      --listen string      Port/IP to listen on (default ":3000")
      --log-level string   Log level (debug, info, warn, error, fatal) (default "info")
      --version            Prints current version and exits

To use this you can

  • download pre-build binaries from the releases
  • pull the Docker image
  • or go get -u github.com/Luzifer/wiki the project

Given you've used the binary you can now just execute ./wiki and go to http://localhost:3000. Everything you save will be stored in the ./data directory.