mirror of
https://github.com/osmarks/mycorrhiza.git
synced 2024-12-11 21:10:26 +00:00
Wiki engine fork.
3f7de07da9
This has several advantages over using an external CLI tool to generate the files, such as having fewer dependencies, less generated files bloat and more flexibility over the localization code. "Sadly", this solution doesn't check for validity of JSON files at compile-time (the only advantage of using an external tool such as go-localize). However, I easily fixed this huge "issue" by making the program crash at startup if any locale files are invalid. Also, no more "go-localize removed from go.mod" "go-localize added to go.mod" "go-localize removed from go.mod" spam. A utility for making sure all translation stay in sync soon! (not sure where to put it) |
||
---|---|---|
.github/workflows | ||
assets | ||
cfg | ||
files | ||
help | ||
history | ||
hyphae | ||
l18n | ||
mimetype | ||
shroom | ||
static | ||
tree | ||
user | ||
util | ||
views | ||
web | ||
.gitignore | ||
config.example.mk | ||
Dockerfile | ||
flag.go | ||
go.mod | ||
go.sum | ||
httpd.go | ||
LICENSE | ||
main.go | ||
Makefile | ||
README.md |
🍄 Mycorrhiza Wiki
Mycorrhiza Wiki is a lightweight file-system wiki engine that uses Git for keeping history. Main wiki
Features
- No database required. Everything is stored in plain files. It makes installation super easy, and you can modify the content directly by yourself.
- Everything is hyphae. A hypha is a unit of content such as a picture, video or a text article. Hyphae can transclude and link each other resulting in a tight network of hypertext pages.
- Hyphae are authored in Mycomarkup, a markup language that's designed to be unambigious yet easy to use.
- Nesting of hyphae is supported. A tree of related hyphae is shown on every page.
- History of changes for textual parts of hyphae. Every change is safely stored in Git. Web feeds for recent changes included!
- Keyboard-driven navigation. Press
?
to see the list of shortcuts. - Support for authorization.
- Open Graph support.
- Optional Telegram authentication.
Compare Mycorrhiza Wiki with other engines on WikiMatrix.
Installing
See the deployment guide on the wiki.
Contributing
Help is always welcome! We have an IRC channel #mycorrhiza on irc.libera.chat and a Telegram chat for discussions and development. You can also sponsor the maintainer of Mycorrhiza, @bouncepaw, on Boosty. If you want to contribute with code, you can either open a pull request on GitHub or send a patch to the mailing list. Feel free to open an issue on GitHub or contact us directly.
You can view the list of planned features at our GitHub project kanban board or on the roadmap page.