From e885d01532094762d78f3fec15a4d48dabc38f5d Mon Sep 17 00:00:00 2001 From: Umar Getagazov Date: Wed, 10 Nov 2021 18:43:20 +0700 Subject: [PATCH] Update README.md --- README.md | 55 +++++++++++++++++++++++++++---------------------------- 1 file changed, 27 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 99e3ff0..34d17be 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,20 @@ # 🍄 Mycorrhiza Wiki + **Mycorrhiza Wiki** is a lightweight file-system wiki engine that uses Git for keeping history. [Main wiki](https://mycorrhiza.wiki) -A screenshot of mycorrhiza.wiki's home page in the Safari browser +A screenshot of mycorrhiza.wiki's home page in the Safari browser ## 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][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. -* **Hyphae are authored in [Mycomarkup][mycomarkup],** a custom markup language that's designed to be unambigious and easy to use. +* **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. * **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! +* **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][feature-authorization].** -* **[Opengraph][standard-og] support.** -* **Optional [Telegram][telegram] authentication.** +* **Support for [authorization].** +* **[Opengraph] support.** +* **Optional [Telegram] authentication.** Compare Mycorrhiza Wiki with other engines on [WikiMatrix](https://www.wikimatrix.org/show/mycorrhiza). @@ -23,29 +24,27 @@ See [the deployment guide](https://mycorrhiza.wiki/hypha/guide/deployment) on th ## Contributing -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, -[@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. +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][kanban] or on the [roadmap page][roadmap]. +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 +[Opengraph]: https://mycorrhiza.wiki/hypha/standard/opengraph +[Telegram]: https://mycorrhiza.wiki/help/en/telegram -[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 - -[irc]: irc://irc.libera.chat/#mycorrhiza -[tg]: https://t.me/mycorrhizadev -[bp]: https://github.com/bouncepaw -[bp-donate]: https://boosty.to/bouncepaw -[mlist]: https://lists.sr.ht/~handlerug/mycorrhiza-devel +[#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 [kanban]: https://github.com/bouncepaw/mycorrhiza/projects/1 -[roadmap]: https://mycorrhiza.wiki/hypha/release/roadmap +[roadmap page]: https://mycorrhiza.wiki/hypha/release/roadmap