2021-07-01 18:52:59 +00:00
# 🍄 Mycorrhiza Wiki
2021-11-10 11:43:20 +00:00
2021-10-27 06:54:29 +00:00
**Mycorrhiza Wiki** is a lightweight file-system wiki engine that uses Git for keeping history. [Main wiki ](https://mycorrhiza.wiki )
2021-06-14 21:07:31 +00:00
2021-11-10 11:43:20 +00:00
< img src = "https://mycorrhiza.wiki/binary/release/1.6/screenshot" alt = "A screenshot of mycorrhiza.wiki's home page in the Safari browser" width = "600" >
2021-08-11 05:41:53 +00:00
2020-10-03 17:05:10 +00:00
## Features
2020-07-19 15:00:44 +00:00
2021-08-11 05:41:53 +00:00
* **No database required.** Everything is stored in plain files. It makes installation super easy, and you can modify the content directly by yourself.
2021-11-10 11:43:20 +00:00
* **Everything is hyphae.** A [hypha] is a unit of content such as a picture, video or a text article. Hyphae can [transclude][transclusion] 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.
2021-07-01 18:52:59 +00:00
* **Nesting of hyphae** is supported. A tree of related hyphae is shown on every page.
2021-11-10 11:43:20 +00:00
* **History of changes** for textual parts of hyphae. Every change is safely stored in [Git]. Web feeds for recent changes included!
2021-07-01 18:52:59 +00:00
* **Keyboard-driven navigation.** Press `?` to see the list of shortcuts.
2021-11-10 11:43:20 +00:00
* **Support for [authorization].**
2021-11-10 12:33:14 +00:00
* **[Open Graph] support.**
2021-11-10 11:43:20 +00:00
* **Optional [Telegram] authentication.**
2021-07-01 18:52:59 +00:00
2021-08-11 05:41:53 +00:00
Compare Mycorrhiza Wiki with other engines on [WikiMatrix ](https://www.wikimatrix.org/show/mycorrhiza ).
2021-06-12 15:51:29 +00:00
2021-06-14 21:07:31 +00:00
## Installing
2021-06-12 15:51:29 +00:00
2021-08-12 14:09:26 +00:00
See [the deployment guide ](https://mycorrhiza.wiki/hypha/guide/deployment ) on the wiki.
2021-06-12 15:51:29 +00:00
2021-07-01 18:52:59 +00:00
## Contributing
2021-06-12 15:51:29 +00:00
2021-11-10 11:43:20 +00:00
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.
2021-06-12 15:51:29 +00:00
2021-08-11 05:41:53 +00:00
You can view the list of planned features at [our GitHub project kanban
2021-11-10 11:43:20 +00:00
board][kanban] or on the [roadmap page].
[hypha]: https://mycorrhiza.wiki/hypha/feature/hypha
[transclusion]: https://mycorrhiza.wiki/hypha/feature/transclusion
[authorization]: https://mycorrhiza.wiki/hypha/feature/authorization
[Mycomarkup]: https://mycorrhiza.wiki/help/en/mycomarkup
[Git]: https://mycorrhiza.wiki/hypha/integration/git
2021-11-10 12:33:14 +00:00
[Open Graph]: https://mycorrhiza.wiki/hypha/standard/opengraph
2021-11-10 11:43:20 +00:00
[Telegram]: https://mycorrhiza.wiki/help/en/telegram
[#mycorrhiza on irc.libera.chat]: irc://irc.libera.chat/#mycorrhiza
[Telegram chat]: https://t.me/mycorrhizadev
[@bouncepaw]: https://github.com/bouncepaw
[Boosty]: https://boosty.to/bouncepaw
[mailing list]: https://lists.sr.ht/~handlerug/mycorrhiza-devel
2021-08-11 05:41:53 +00:00
[kanban]: https://github.com/bouncepaw/mycorrhiza/projects/1
2021-11-10 11:43:20 +00:00
[roadmap page]: https://mycorrhiza.wiki/hypha/release/roadmap
