GoWiki/README.md

34 lines
1.4 KiB
Markdown
Raw Normal View History

2019-12-13 08:57:01 +01:00
# GoWiki
Ein kleines, in Go gebasteltes Wiki.
Jede Seite kann über den `Edit` Button oben rechts in der Ecke bearbeitet werden.
2019-12-13 12:35:33 +01:00
Der Obere Teil der Sidebar kommt aus der Datei `sidebar.md` (kann auch über den Link: [/sidebar](/sidebar) aufgerufen werden).
2019-12-13 08:57:01 +01:00
Der untere Teil der Sidebar wird dynmaisch zur Laufzeit generiert und spiegelt den Inhalt des `data`-Ordners wieder.
Eine Hilfe der Markdown-Syntax kann man unter [/hilfe](/hilfe) einsehen.
Unter [/playground](/playground) gibt es eine Test-Seite zum Testen.
2019-12-13 12:35:33 +01:00
Standardmäßig wird das Wiki unter der `http://127.0.0.1` und dem Port `8000` gestartet und verwendet die `*.md` Files, welche sich im Unterverzeichnis `./data` befinden.
2019-12-13 08:57:01 +01:00
Diese Einstellungen können durch eine `config.json` im Start-Verzeichnis geändert werden:
Eine `config.json` könnte z.B. wie folgt aussehen:
```
{
"Host":"http://127.0.0.1",
"Port":"8000",
"DataPath":"./data",
"DataPathFTS":"./FTSData"
2019-12-13 08:57:01 +01:00
}
```
2019-12-13 12:35:33 +01:00
Zum kompilieren folgende Go-Abhängigkeiten installieren:
2019-12-13 08:57:01 +01:00
- `go get github.com/gorilla/mux`
2019-12-13 12:30:55 +01:00
- `go get gopkg.in/src-d/go-git.v4`
- `go get github.com/mandolyte/mdtopdf`
- `go get github.com/blevesearch/bleve`
2019-12-13 08:57:01 +01:00
2019-12-13 12:35:33 +01:00
Die Build-Scripte liegen im Unterordner `build`
2019-12-13 12:30:55 +01:00
2019-12-13 12:35:33 +01:00
Download der Binaries unter: [https://nc.masilux.de/index.php/s/dGRdPsa6XPPiyQk](https://nc.masilux.de/index.php/s/dGRdPsa6XPPiyQk)