diff --git a/README.md b/README.md index cb0fbfc..6c624ee 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # 🍄 Mycorrhiza Wiki -A screenshot of Mycorrhiza Wiki's home page in the Safari browser -**Mycorrhiza Wiki** is a filesystem-backed wiki engine that uses Git for -keeping history. +A screenshot of mycorrhiza.wiki's home page in the Safari browser + +**Mycorrhiza Wiki** is a lightweight file-system wiki engine that uses Git for keeping history. [👉 Main wiki](https://mycorrhiza.wiki) ## Features -* **No database required.** Everything is stored as simple files. It makes installation super easy, and you can modify the content directly. +* **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. * **Nesting of hyphae** is supported. A tree of related hyphae is shown on every page. @@ -16,21 +16,13 @@ keeping history. * **Keyboard-driven navigation.** Press `?` to see the list of shortcuts. * **Support for [authorization][feature-authorization].** * **[Opengraph][standard-og] support.** -* **Optional [Telegram][telegram] integraion.** +* **Optional [Telegram][telegram] authentication.** -[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 +Compare Mycorrhiza Wiki with other engines on [WikiMatrix](https://www.wikimatrix.org/show/mycorrhiza). ## Installing -See [the deployment guide][deployment] on the wiki. - -[deployment]: https://mycorrhiza.wiki/hypha/guide/deployment +See [the deployment guide][https://mycorrhiza.wiki/hypha/guide/deployment] on the wiki. ## Contributing @@ -41,13 +33,22 @@ development. You can also sponsor the maintainer of Mycorrhiza, 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. +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 + [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 - -You can view the list of planned features on [our GitHub project kanban -board](https://github.com/bouncepaw/mycorrhiza/projects/1). - -Compare Mycorrhiza Wiki with other engines on [WikiMatrix](https://www.wikimatrix.org/show/mycorrhiza). \ No newline at end of file +[kanban]: https://github.com/bouncepaw/mycorrhiza/projects/1 +[roadmap]: https://mycorrhiza.wiki/hypha/release/roadmap