README
¶
🍄 Mycorrhiza Wiki
Mycorrhiza Wiki is a lightweight file-system wiki engine that uses Git for keeping history. Main wiki
Features
- No database used. 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, forming a tight network of hypertext pages.
- Hyphae are authored in Mycomarkup, a markup language that's designed to be unambiguous yet easy to use.
- Categories let you organize hyphae without any hierarchy restrictions, with all the benefits of a category system.
- Nesting of hyphae is also supported if you like hierarchies.
- History of changes. Every change is safely stored in Git. Web feeds (RSS, Atom, JSON Feed) for recent changes included.
- Keyboard-driven navigation. Press
?to see the list of shortcuts. - Support for authorization. Both plain username-password pairs and Telegram's login widget are supported.
- Open Graph support. The most relevant info about a hypha is made available through OG meta tags for consumption by other software.
- Interwiki support.
Compare Mycorrhiza Wiki with other engines on WikiMatrix.
Installing
See the deployment guide on the wiki. Also, Mycorrhiza might be available in your repositories. See Repology.
Contributing and community
If you want to contribute with code, open a pull request on GitHub or send a patch to the mailing list. If you want to report an issue, open an issue on GitHub or contact us directly.
Consider supporting the development on Boosty.
Check out Betula as well.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
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. |
|
histweb
Package histweb provides web stuff for history
|
Package histweb provides web stuff for history |
|
internal
|
|
|
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. |
|
categories
Package categories provides category management.
|
Package categories provides category management. |
|
cfg
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. |
|
files
Package files is used to get paths to different files Mycorrhiza uses.
|
Package files is used to get paths to different files Mycorrhiza uses. |
|
hyphae
Package hyphae manages hypha storage and hypha types.
|
Package hyphae manages hypha storage and hypha types. |
|
migration
Package migration holds the utilities for migrating from older incompatible Mycomarkup versions.
|
Package migration holds the utilities for migrating from older incompatible Mycomarkup versions. |
|
shroom
Package shroom provides utilities for hypha manipulation.
|
Package shroom provides utilities for hypha manipulation. |
|
Package interwiki provides interwiki capabilities.
|
Package interwiki provides interwiki capabilities. |
|
Package l18n handles everything language-related for Mycorrhiza.
|
Package l18n handles everything language-related for Mycorrhiza. |
|
Package misc provides miscellaneous informative views.
|
Package misc provides miscellaneous informative views. |
|
Package web contains web handlers and initialization stuff.
|
Package web contains web handlers and initialization stuff. |
|
viewutil
Package viewutil provides utilities and common templates for views across all packages.
|
Package viewutil provides utilities and common templates for views across all packages. |
Click to show internal directories.
Click to hide internal directories.