mirror of
https://github.com/osmarks/mycorrhiza.git
synced 2024-10-30 11:46:16 +00:00
Wiki engine fork.
839f8bc2d6
assets.qtpl is no more! Now you can just add files to static/ folder, make sure the extension is registered in static.go (a shortcoming that'll be addressed in future Go versions), and you're done! It searches the local file system first, then falls back to the files embedded with the binary (in the static/ folder). |
||
|---|---|---|
| .github/workflows | ||
| .idea | ||
| assets | ||
| cfg | ||
| files | ||
| history | ||
| hyphae | ||
| mimetype | ||
| shroom | ||
| static | ||
| tree | ||
| user | ||
| util | ||
| views | ||
| web | ||
| .gitignore | ||
| .gitmodules | ||
| default.nix | ||
| Dockerfile | ||
| flag.go | ||
| gemini.go | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| main.go | ||
| Makefile | ||
| mycocredentials.json | ||
| PKGBUILD | ||
| README.md | ||
| release.nix | ||
🍄 MycorrhizaWiki 1.2
A wiki engine.
Building
See the guide on the wiki.
Installing
Pacman
If you use a linux distro with pacman package manager (Arch, Manjaro, Garuda, etc) you can install it using PKGBUILD:
$ wget https://raw.githubusercontent.com/bouncepaw/mycorrhiza/master/PKGBUILD
$ makepkg --install
Docker
You can run Mycorrhiza Wiki in Docker using Dockerfile provided by this repository. Clone the repo and build the image:
$ git clone https://github.com/bouncepaw/mycorrhiza/
$ docker build -t mycorrhiza .
Now you can create a new Mycorrhiza Wiki container using this command:
$ docker run -v /full/path/to/my/wiki:/wiki -p 1737:1737 mycorrhiza
Example:
$ cd /dev/shm
$ git clone https://github.com/bouncepaw/mycorrhiza/
$ docker build -t mycorrhiza .
$ git clone https://github.com/bouncepaw/example-wiki
$ docker run -v /dev/shm/example-wiki:/wiki -p 1737:1737 mycorrhiza
Example 2:
...
$ docker run -v /dev/shm/:/config -v /dev/shm/example-wiki:/wiki -p 80:1737 mycorrhiza -config-path /config/myconfig.ini /wiki
Usage
mycorrhiza [OPTIONS...] WIKI_PATH
WIKI_PATH must be a path to a git repository which you want to be a wiki.
Options:
-config-path string
Path to a configuration file. Leave empty if you don't want to use it.
-print-example-config
If true, print an example configuration file contents and exit. You can save the output to a file and base your own configuration on it.
Features
- Wiki pages (called hyphae) are written in mycomarkup
- Edit pages through html forms, a graphical preview and a toolbar that helps you use mycomarkup
- Responsive design, dark theme (synced with system theme)
- Works in text browsers
- Everything is stored as simple files, no database required. You can run a wiki on almost any directory and get something to work with
- Page trees; links to previous and next pages
- Changes are saved to git
- List of hyphae page
- History page
- Random page
- Recent changes page; RSS, Atom and JSON feeds available
- Hyphae can be deleted while still preserving history
- Hyphae can be renamed (recursive renaming of subhyphae is also supported)
- Light on resources
- Authorization with pre-set credentials, registration
- Basic Gemini protocol support
Contributing
Help is always needed. We have a tg chat where some development is coordinated. You can also sponsor bouncepaw on boosty. Feel free to open an issue or contact us directly.
You can view list of all planned features on our kanban board.