README
¶
🍄 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.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cfg contains global variables that represent the current wiki configuration, including CLI options, configuration file values and header links.
|
Package cfg contains global variables that represent the current wiki configuration, including CLI options, configuration file values and header links. |
|
Package files is used to get paths to different files Mycorrhiza uses.
|
Package files is used to get paths to different files Mycorrhiza uses. |
|
Package help contains help messages and the utilities for retrieving them.
|
Package help contains help messages and the utilities for retrieving them. |
|
Package history provides a git wrapper.
|
Package history provides a git wrapper. |
|
backlinks
Package backlinks maintains the index of backlinks and lets you update it and query it.
|
Package backlinks maintains the index of backlinks and lets you update it and query it. |
|
Package l18n handles everything language-related for Mycorrhiza.
|
Package l18n handles everything language-related for Mycorrhiza. |
|
Package migration holds the utilities for migrating from older incompatible Mycomarkup versions.
|
Package migration holds the utilities for migrating from older incompatible Mycomarkup versions. |
|
Package web contains web handlers and initialization stuff.
|
Package web contains web handlers and initialization stuff. |
Click to show internal directories.
Click to hide internal directories.