2021-07-01 18:52:59 +00:00
# 🍄 Mycorrhiza Wiki
2021-06-14 21:07:31 +00:00
2021-08-11 05:41:53 +00:00
< img src = "https://mycorrhiza.wiki/binary/release/1.3/screenshot" alt = "A screenshot of mycorrhiza.wiki's home page in the Safari browser" width = "600" >
**Mycorrhiza Wiki** is a lightweight file-system wiki engine that uses Git for keeping history.
2020-09-01 16:52:40 +00:00
2021-07-31 12:44:12 +00:00
[👉 Main wiki ](https://mycorrhiza.wiki )
2020-10-25 15:06:51 +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-07-31 12:39:26 +00:00
* **Everything is hyphae.** A [hypha][feature-hypha] is a unit of content such as a picture, video or a text article. Hyphae can [transclude][feature-transclusion] and link each other resulting in a tight network of hypertext pages.
2021-07-01 18:52:59 +00:00
* **Hyphae are authored in [Mycomarkup][mycomarkup],** a custom markup language that's designed to be unambigious and 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][integration-git]. Web feeds for recent changes included!
* **Keyboard-driven navigation.** Press `?` to see the list of shortcuts.
* **Support for [authorization][feature-authorization].**
* **[Opengraph][standard-og] support.**
2021-08-11 05:41:53 +00:00
* **Optional [Telegram][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-07-08 18:19:12 +00:00
Help is always welcome! We have an IRC channel [#mycorrhiza on
irc.libera.chat][irc] and a [Telegram chat][tg] for discussions and
development. You can also sponsor the maintainer of Mycorrhiza,
2021-07-01 18:52:59 +00:00
[@bouncepaw][bp], on [Boosty][bp-donate]. If you want to contribute with code,
you can either open a pull request on GitHub or send a patch to the [mailing
list][mlist]. 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
board][kanban] or on the [roadmap page][roadmap].
[feature-hypha]: https://mycorrhiza.wiki/hypha/feature/hypha
[feature-transclusion]: https://mycorrhiza.wiki/hypha/feature/transclusion
[feature-authorization]: https://mycorrhiza.wiki/hypha/feature/authorization
[mycomarkup]: https://mycorrhiza.wiki/help/en/mycomarkup
[integration-git]: https://mycorrhiza.wiki/hypha/integration/git
[standard-og]: https://mycorrhiza.wiki/hypha/standard/opengraph
[telegram]: https://mycorrhiza.wiki/help/en/telegram
2021-07-08 18:19:12 +00:00
[irc]: irc://irc.libera.chat/#mycorrhiza
2021-07-01 18:52:59 +00:00
[tg]: https://t.me/mycorrhizadev
[bp]: https://github.com/bouncepaw
[bp-donate]: https://boosty.to/bouncepaw
[mlist]: https://lists.sr.ht/~handlerug/mycorrhiza-devel
2021-08-11 05:41:53 +00:00
[kanban]: https://github.com/bouncepaw/mycorrhiza/projects/1
[roadmap]: https://mycorrhiza.wiki/hypha/release/roadmap
